README.txt

Same filename in this branch
  1. 9 sites/README.txt
  2. 9 composer/Metapackage/README.txt
  3. 9 composer/Plugin/VendorHardening/README.txt
  4. 9 profiles/README.txt
  5. 9 themes/README.txt
  6. 9 modules/README.txt
  7. 9 core/profiles/demo_umami/themes/umami/README.txt
  8. 9 core/profiles/demo_umami/themes/umami/images/classy/README.txt
  9. 9 core/profiles/demo_umami/themes/umami/css/classy/README.txt
  10. 9 core/profiles/demo_umami/themes/umami/js/classy/README.txt
  11. 9 core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  12. 9 core/themes/stable9/README.txt
  13. 9 core/themes/stable9/images/README.txt
  14. 9 core/themes/seven/README.txt
  15. 9 core/themes/seven/images/classy/README.txt
  16. 9 core/themes/seven/css/classy/README.txt
  17. 9 core/themes/seven/js/classy/README.txt
  18. 9 core/themes/seven/templates/classy/README.txt
  19. 9 core/themes/claro/images/classy/README.txt
  20. 9 core/themes/claro/css/classy/README.txt
  21. 9 core/themes/claro/js/classy/README.txt
  22. 9 core/themes/claro/templates/classy/README.txt
  23. 9 core/themes/stark/README.txt
  24. 9 core/themes/bartik/README.txt
  25. 9 core/themes/bartik/images/classy/README.txt
  26. 9 core/themes/bartik/css/classy/README.txt
  27. 9 core/themes/bartik/js/classy/README.txt
  28. 9 core/themes/bartik/templates/classy/README.txt
  29. 9 core/themes/stable/README.txt
  30. 9 core/themes/classy/README.txt
  31. 9 core/modules/system/tests/src/Functional/UpdateSystem/README.txt
  32. 9 core/modules/system/tests/src/Functional/Update/README.txt
  33. 9 core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  34. 9 core/tests/fixtures/files/README.txt
  35. 9 core/assets/scaffold/README.txt
  36. 9 core/assets/vendor/tabbable/README.txt
  37. 9 core/lib/Drupal/Core/README.txt
  38. 9 core/lib/Drupal/Component/Render/README.txt
  39. 9 core/lib/Drupal/Component/Assertion/README.txt
  40. 9 core/lib/Drupal/Component/Discovery/README.txt
  41. 9 core/lib/Drupal/Component/FileSecurity/README.txt
  42. 9 core/lib/Drupal/Component/FileCache/README.txt
  43. 9 core/lib/Drupal/Component/Utility/README.txt
  44. 9 core/lib/Drupal/Component/README.txt
  45. 9 core/lib/Drupal/Component/Graph/README.txt
  46. 9 core/lib/Drupal/Component/DependencyInjection/README.txt
  47. 9 core/lib/Drupal/Component/FrontMatter/README.txt
  48. 9 core/lib/Drupal/Component/Version/README.txt
  49. 9 core/lib/Drupal/Component/Serialization/README.txt
  50. 9 core/lib/Drupal/Component/ClassFinder/README.txt
  51. 9 core/lib/Drupal/Component/ProxyBuilder/README.txt
  52. 9 core/lib/Drupal/Component/EventDispatcher/README.txt
  53. 9 core/lib/Drupal/Component/Diff/README.txt
  54. 9 core/lib/Drupal/Component/FileSystem/README.txt
  55. 9 core/lib/Drupal/Component/Gettext/README.txt
  56. 9 core/lib/Drupal/Component/Bridge/README.txt
  57. 9 core/lib/Drupal/Component/PhpStorage/README.txt
  58. 9 core/lib/Drupal/Component/Datetime/README.txt
  59. 9 core/lib/Drupal/Component/Transliteration/README.txt
  60. 9 core/lib/Drupal/Component/Annotation/README.txt
  61. 9 core/lib/Drupal/Component/HttpFoundation/README.txt
  62. 9 core/lib/Drupal/Component/Uuid/README.txt
  63. 9 core/lib/Drupal/Component/Plugin/README.txt
  64. 9 core/lib/README.txt
Same filename in other branches
  1. 7.x sites/README.txt
  2. 7.x sites/all/themes/README.txt
  3. 7.x sites/all/modules/README.txt
  4. 7.x sites/all/libraries/README.txt
  5. 7.x profiles/README.txt
  6. 7.x profiles/standard/translations/README.txt
  7. 7.x profiles/minimal/translations/README.txt
  8. 7.x README.txt
  9. 7.x themes/README.txt
  10. 7.x themes/stark/README.txt
  11. 7.x modules/README.txt
  12. 7.x modules/simpletest/files/README.txt
  13. 8.9.x sites/README.txt
  14. 8.9.x composer/Template/README.txt
  15. 8.9.x composer/Metapackage/README.txt
  16. 8.9.x composer/Plugin/VendorHardening/README.txt
  17. 8.9.x profiles/README.txt
  18. 8.9.x README.txt
  19. 8.9.x themes/README.txt
  20. 8.9.x modules/README.txt
  21. 8.9.x core/profiles/demo_umami/themes/umami/README.txt
  22. 8.9.x core/profiles/demo_umami/themes/umami/images/classy/README.txt
  23. 8.9.x core/profiles/demo_umami/themes/umami/css/classy/README.txt
  24. 8.9.x core/profiles/demo_umami/themes/umami/js/classy/README.txt
  25. 8.9.x core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  26. 8.9.x core/themes/seven/README.txt
  27. 8.9.x core/themes/seven/images/classy/README.txt
  28. 8.9.x core/themes/seven/css/classy/README.txt
  29. 8.9.x core/themes/seven/js/classy/README.txt
  30. 8.9.x core/themes/seven/templates/classy/README.txt
  31. 8.9.x core/themes/claro/images/classy/README.txt
  32. 8.9.x core/themes/claro/css/classy/README.txt
  33. 8.9.x core/themes/claro/js/classy/README.txt
  34. 8.9.x core/themes/claro/templates/classy/README.txt
  35. 8.9.x core/themes/stark/README.txt
  36. 8.9.x core/themes/bartik/README.txt
  37. 8.9.x core/themes/bartik/images/classy/README.txt
  38. 8.9.x core/themes/bartik/css/classy/README.txt
  39. 8.9.x core/themes/bartik/js/classy/README.txt
  40. 8.9.x core/themes/bartik/templates/classy/README.txt
  41. 8.9.x core/themes/stable/README.txt
  42. 8.9.x core/themes/classy/README.txt
  43. 8.9.x core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  44. 8.9.x core/tests/fixtures/files/README.txt
  45. 8.9.x core/assets/scaffold/README.txt
  46. 8.9.x core/lib/Drupal/Core/README.txt
  47. 8.9.x core/lib/Drupal/Component/Render/README.txt
  48. 8.9.x core/lib/Drupal/Component/Assertion/README.txt
  49. 8.9.x core/lib/Drupal/Component/Discovery/README.txt
  50. 8.9.x core/lib/Drupal/Component/FileSecurity/README.txt
  51. 8.9.x core/lib/Drupal/Component/FileCache/README.txt
  52. 8.9.x core/lib/Drupal/Component/Utility/README.txt
  53. 8.9.x core/lib/Drupal/Component/README.txt
  54. 8.9.x core/lib/Drupal/Component/Graph/README.txt
  55. 8.9.x core/lib/Drupal/Component/DependencyInjection/README.txt
  56. 8.9.x core/lib/Drupal/Component/Version/README.txt
  57. 8.9.x core/lib/Drupal/Component/Serialization/README.txt
  58. 8.9.x core/lib/Drupal/Component/ClassFinder/README.txt
  59. 8.9.x core/lib/Drupal/Component/ProxyBuilder/README.txt
  60. 8.9.x core/lib/Drupal/Component/EventDispatcher/README.txt
  61. 8.9.x core/lib/Drupal/Component/Diff/README.txt
  62. 8.9.x core/lib/Drupal/Component/FileSystem/README.txt
  63. 8.9.x core/lib/Drupal/Component/Gettext/README.txt
  64. 8.9.x core/lib/Drupal/Component/Bridge/README.txt
  65. 8.9.x core/lib/Drupal/Component/PhpStorage/README.txt
  66. 8.9.x core/lib/Drupal/Component/Datetime/README.txt
  67. 8.9.x core/lib/Drupal/Component/Transliteration/README.txt
  68. 8.9.x core/lib/Drupal/Component/Annotation/README.txt
  69. 8.9.x core/lib/Drupal/Component/HttpFoundation/README.txt
  70. 8.9.x core/lib/Drupal/Component/Uuid/README.txt
  71. 8.9.x core/lib/Drupal/Component/Plugin/README.txt
  72. 8.9.x core/lib/README.txt
  73. 10 sites/README.txt
  74. 10 composer/Template/README.txt
  75. 10 composer/Metapackage/README.txt
  76. 10 composer/Plugin/VendorHardening/README.txt
  77. 10 profiles/README.txt
  78. 10 themes/README.txt
  79. 10 modules/README.txt
  80. 10 core/profiles/demo_umami/themes/umami/README.txt
  81. 10 core/profiles/demo_umami/themes/umami/images/classy/README.txt
  82. 10 core/profiles/demo_umami/themes/umami/css/classy/README.txt
  83. 10 core/profiles/demo_umami/themes/umami/js/classy/README.txt
  84. 10 core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  85. 10 core/themes/stable9/README.txt
  86. 10 core/themes/claro/images/classy/README.txt
  87. 10 core/themes/claro/css/classy/README.txt
  88. 10 core/themes/claro/js/classy/README.txt
  89. 10 core/themes/claro/templates/classy/README.txt
  90. 10 core/themes/stark/README.txt
  91. 10 core/modules/sdc/README.txt
  92. 10 core/modules/system/tests/src/Functional/UpdateSystem/README.txt
  93. 10 core/modules/system/tests/src/Functional/Update/README.txt
  94. 10 core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  95. 10 core/tests/fixtures/files/README.txt
  96. 10 core/assets/scaffold/README.txt
  97. 10 core/assets/vendor/tabbable/README.txt
  98. 10 core/lib/Drupal/Core/README.txt
  99. 10 core/lib/Drupal/Component/Render/README.txt
  100. 10 core/lib/Drupal/Component/Assertion/README.txt
  101. 10 core/lib/Drupal/Component/Discovery/README.txt
  102. 10 core/lib/Drupal/Component/FileSecurity/README.txt
  103. 10 core/lib/Drupal/Component/FileCache/README.txt
  104. 10 core/lib/Drupal/Component/Utility/README.txt
  105. 10 core/lib/Drupal/Component/README.txt
  106. 10 core/lib/Drupal/Component/Graph/README.txt
  107. 10 core/lib/Drupal/Component/DependencyInjection/README.txt
  108. 10 core/lib/Drupal/Component/FrontMatter/README.txt
  109. 10 core/lib/Drupal/Component/Version/README.txt
  110. 10 core/lib/Drupal/Component/Serialization/README.txt
  111. 10 core/lib/Drupal/Component/ClassFinder/README.txt
  112. 10 core/lib/Drupal/Component/ProxyBuilder/README.txt
  113. 10 core/lib/Drupal/Component/EventDispatcher/README.txt
  114. 10 core/lib/Drupal/Component/Diff/README.txt
  115. 10 core/lib/Drupal/Component/FileSystem/README.txt
  116. 10 core/lib/Drupal/Component/Gettext/README.txt
  117. 10 core/lib/Drupal/Component/PhpStorage/README.txt
  118. 10 core/lib/Drupal/Component/Datetime/README.txt
  119. 10 core/lib/Drupal/Component/Transliteration/README.txt
  120. 10 core/lib/Drupal/Component/Annotation/README.txt
  121. 10 core/lib/Drupal/Component/HttpFoundation/README.txt
  122. 10 core/lib/Drupal/Component/Uuid/README.txt
  123. 10 core/lib/Drupal/Component/Plugin/README.txt
  124. 10 core/lib/README.txt
  125. 11.x sites/README.txt
  126. 11.x composer/Template/README.txt
  127. 11.x composer/Metapackage/README.txt
  128. 11.x composer/Plugin/VendorHardening/README.txt
  129. 11.x profiles/README.txt
  130. 11.x themes/README.txt
  131. 11.x modules/README.txt
  132. 11.x core/profiles/demo_umami/themes/umami/README.txt
  133. 11.x core/profiles/demo_umami/themes/umami/images/classy/README.txt
  134. 11.x core/profiles/demo_umami/themes/umami/css/classy/README.txt
  135. 11.x core/profiles/demo_umami/themes/umami/js/classy/README.txt
  136. 11.x core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  137. 11.x core/themes/stable9/README.txt
  138. 11.x core/themes/claro/images/classy/README.txt
  139. 11.x core/themes/claro/css/classy/README.txt
  140. 11.x core/themes/claro/js/classy/README.txt
  141. 11.x core/themes/claro/templates/classy/README.txt
  142. 11.x core/themes/stark/README.txt
  143. 11.x core/modules/sdc/README.txt
  144. 11.x core/modules/system/tests/src/Functional/UpdateSystem/README.txt
  145. 11.x core/modules/system/tests/src/Functional/Update/README.txt
  146. 11.x core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  147. 11.x core/tests/fixtures/files/README.txt
  148. 11.x core/assets/scaffold/README.txt
  149. 11.x core/assets/vendor/tabbable/README.txt
  150. 11.x core/lib/Drupal/Core/README.txt
  151. 11.x core/lib/Drupal/Component/Render/README.txt
  152. 11.x core/lib/Drupal/Component/Assertion/README.txt
  153. 11.x core/lib/Drupal/Component/Discovery/README.txt
  154. 11.x core/lib/Drupal/Component/FileSecurity/README.txt
  155. 11.x core/lib/Drupal/Component/FileCache/README.txt
  156. 11.x core/lib/Drupal/Component/Utility/README.txt
  157. 11.x core/lib/Drupal/Component/README.txt
  158. 11.x core/lib/Drupal/Component/Graph/README.txt
  159. 11.x core/lib/Drupal/Component/DependencyInjection/README.txt
  160. 11.x core/lib/Drupal/Component/FrontMatter/README.txt
  161. 11.x core/lib/Drupal/Component/Version/README.txt
  162. 11.x core/lib/Drupal/Component/Serialization/README.txt
  163. 11.x core/lib/Drupal/Component/ClassFinder/README.txt
  164. 11.x core/lib/Drupal/Component/ProxyBuilder/README.txt
  165. 11.x core/lib/Drupal/Component/EventDispatcher/README.txt
  166. 11.x core/lib/Drupal/Component/Diff/README.txt
  167. 11.x core/lib/Drupal/Component/FileSystem/README.txt
  168. 11.x core/lib/Drupal/Component/Gettext/README.txt
  169. 11.x core/lib/Drupal/Component/PhpStorage/README.txt
  170. 11.x core/lib/Drupal/Component/Datetime/README.txt
  171. 11.x core/lib/Drupal/Component/Transliteration/README.txt
  172. 11.x core/lib/Drupal/Component/Annotation/README.txt
  173. 11.x core/lib/Drupal/Component/HttpFoundation/README.txt
  174. 11.x core/lib/Drupal/Component/Uuid/README.txt
  175. 11.x core/lib/Drupal/Component/Plugin/README.txt
  176. 11.x core/lib/README.txt
Composer-Ready Project Templates
================================

Thanks for using these Drupal project templates.

You can participate in its development on Drupal.org, through our issue system:
https://www.drupal.org/project/issues/drupal

You can get the full Drupal repo here:
https://www.drupal.org/project/drupal/git-instructions

You can browse the full Drupal repo here:
https://git.drupalcode.org/drupal

What does it do?
----------------

These project templates serve as a starting point for creating a
Composer-managed Drupal site. Once you have selected a template project and
created your own site, you will take ownership of your new project files.
Thereafter, future updates will be done with Composer.

There are two project templates to choose from:

1) drupal/recommended-project: The recommended project creates a new Drupal site
with a "relocated document root". This means that the files "index.php" and the
"core" directory and so on are placed inside a subfolder named "web" rather than
being placed next to "composer.json" and the "vendor" directory at the project
root. This layout is recommended because it allows you to configure your web
server to only provide access to files inside the "web" directory. Keeping the
vendor directory outside of the web server's document root is better for
security.

2) drupal/legacy-project: The legacy project creates a new Drupal site that has
the same layout used in Drupal 8.7.x and earlier. The files "index.php", the
"core" directory and so on are placed directly at the project root next to
"composer.json" and the "vendor" directory. The Vendor Hardening plugin is used
to ensure the security of this configuration for the Apache and Microsoft IIS
web servers. Use the legacy project layout only if there is some reason why you
cannot use the recommended project layout.


How do I set it up?
-------------------

Use Composer to create a new project using the desired starter template:

    composer -n create-project drupal/recommended-project my-project

Add new modules and themes with `composer require`:

    composer require drupal/devel:^1

All of your modules and themes can be updated along with Drupal core via:

    composer update

To update only Drupal core without any modules or themes, use:

    composer update drupal/core-recommended --with-dependencies

These template projects use drupal/core-composer-scaffold to place the scaffold
files. This plugin allows the top-level composer.json file for a Drupal site to
transform the scaffold files in different ways, e.g. to append new entries to
the end of robots.txt and so on. For documentation on how scaffolding works, see
https://git.drupalcode.org/project/drupal/tree/8.8.x/composer/Plugin/Scaffold

File

composer/Template/README.txt

View source
  1. Composer-Ready Project Templates
  2. ================================
  3. Thanks for using these Drupal project templates.
  4. You can participate in its development on Drupal.org, through our issue system:
  5. https://www.drupal.org/project/issues/drupal
  6. You can get the full Drupal repo here:
  7. https://www.drupal.org/project/drupal/git-instructions
  8. You can browse the full Drupal repo here:
  9. https://git.drupalcode.org/drupal
  10. What does it do?
  11. ----------------
  12. These project templates serve as a starting point for creating a
  13. Composer-managed Drupal site. Once you have selected a template project and
  14. created your own site, you will take ownership of your new project files.
  15. Thereafter, future updates will be done with Composer.
  16. There are two project templates to choose from:
  17. 1) drupal/recommended-project: The recommended project creates a new Drupal site
  18. with a "relocated document root". This means that the files "index.php" and the
  19. "core" directory and so on are placed inside a subfolder named "web" rather than
  20. being placed next to "composer.json" and the "vendor" directory at the project
  21. root. This layout is recommended because it allows you to configure your web
  22. server to only provide access to files inside the "web" directory. Keeping the
  23. vendor directory outside of the web server's document root is better for
  24. security.
  25. 2) drupal/legacy-project: The legacy project creates a new Drupal site that has
  26. the same layout used in Drupal 8.7.x and earlier. The files "index.php", the
  27. "core" directory and so on are placed directly at the project root next to
  28. "composer.json" and the "vendor" directory. The Vendor Hardening plugin is used
  29. to ensure the security of this configuration for the Apache and Microsoft IIS
  30. web servers. Use the legacy project layout only if there is some reason why you
  31. cannot use the recommended project layout.
  32. How do I set it up?
  33. -------------------
  34. Use Composer to create a new project using the desired starter template:
  35. composer -n create-project drupal/recommended-project my-project
  36. Add new modules and themes with `composer require`:
  37. composer require drupal/devel:^1
  38. All of your modules and themes can be updated along with Drupal core via:
  39. composer update
  40. To update only Drupal core without any modules or themes, use:
  41. composer update drupal/core-recommended --with-dependencies
  42. These template projects use drupal/core-composer-scaffold to place the scaffold
  43. files. This plugin allows the top-level composer.json file for a Drupal site to
  44. transform the scaffold files in different ways, e.g. to append new entries to
  45. the end of robots.txt and so on. For documentation on how scaffolding works, see
  46. https://git.drupalcode.org/project/drupal/tree/8.8.x/composer/Plugin/Scaffold

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.