diff --git a/README.md b/README.md index 4194e89..33ff6e4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -DDEV integration for developing Drupal contrib projects. As a general philosophy, your contributed module is the center of the universe. The codebase layout and commands in this project [match the Gitlab CI approach](https://git.drupalcode.org/project/gitlab_templates) from the Drupal Association. +DDEV integration for developing Drupal contrib projects. As a general philosophy, your contributed module is the center of the universe. The codebase layout (see image below) and commands in this project [match the Gitlab CI approach](https://git.drupalcode.org/project/gitlab_templates) from the Drupal Association. Install =========== @@ -11,13 +11,18 @@ Commands This project provides the following DDEV container commands. - [ddev expand-composer-json](https://github.com/weitzman/ddev-drupal-gitlabci/blob/main/commands/web/expand-composer-json). This edits composer.json so that `drupal/core-recommended` becomes a dev dependency. After this runs you may want to run `ddev composer install` -- [ddev symlink-project](https://github.com/weitzman/ddev-drupal-gitlabci/blob/main/commands/web/symlink-project). This symlinks the top level files of your project into web/moduels/custom so that Drupal finds your module. This command runs automatically on every `ddev start`. +- [ddev symlink-project](https://github.com/weitzman/ddev-drupal-gitlabci/blob/main/commands/web/symlink-project). This symlinks the top level files of your project into web/moduels/custom so that Drupal finds your module. This command runs automatically on every `ddev start`. See image below. - `ddev phpunit`. Run phpunit tests on the web/modules/custom directory. - `ddev nightwatch`. Run nightwatch tests on the web/modules/custom directory. - `ddev phpcs`. Run phpcs on the web/modules/custom directory. - `ddev eslint`. Run eslint on the js files in the web/modules/custom directory. - `ddev stylelint`. Run stylelint on the css files in the web/modules/custom directory. +Codebase layout +================== + +![Folder tree](/assets/folder.png) + Misc ======= - Optional: [Install Chrome service for FunctionalJavascript and Nightwatch tests](https://github.com/ddev/ddev-selenium-standalone-chrome). diff --git a/assets/folder.png b/assets/folder.png new file mode 100644 index 0000000..ba8e7a8 Binary files /dev/null and b/assets/folder.png differ