drupal.README.txt

CONTENTS OF THIS FILE
---------------------

 * About Drupal
 * Configuration and features
 * Installation profiles
 * Appearance
 * Developing for Drupal
 * More information


ABOUT DRUPAL
------------

Drupal is an open source content management platform supporting a variety of
websites ranging from personal weblogs to large community-driven websites. For
more information, see the Drupal website at https://www.drupal.org, and join
the Drupal community at https://www.drupal.org/community.

Legal information about Drupal:
 * Know your rights when using Drupal:
   See LICENSE.txt in the "core" directory.
 * Learn about the Drupal trademark and logo policy:
   https://www.drupal.com/trademark


CONFIGURATION AND FEATURES
--------------------------

Drupal core (what you get when you download and extract a drupal-x.y.tar.gz or
drupal-x.y.zip file from https://www.drupal.org/project/drupal) has what you
need to get started with your website. It includes several modules (extensions
that add functionality) for common website features, such as managing content,
user accounts, image uploading, and search. Core comes with many options that
allow site-specific configuration. In addition to the core modules, there are
thousands of contributed modules (for functionality not included with Drupal
core) available for download.

More about configuration:
 * Install, update, and maintain Drupal:
   See INSTALL.txt and UPDATE.txt in the "core" directory.
 * Learn about how to use Drupal to create your site:
   https://www.drupal.org/documentation
 * Follow best practices:
   https://www.drupal.org/best-practices
 * Download contributed modules to /modules to extend Drupal's functionality:
   https://www.drupal.org/project/modules
 * See also: "Developing for Drupal" for writing your own modules, below.


INSTALLATION PROFILES
---------------------

Installation profiles define additional steps (such as enabling modules,
defining content types, etc.) that run after the base installation provided
by core when Drupal is first installed. There are two basic installation
profiles provided with Drupal core.

Installation profiles from the Drupal community modify the installation process
to provide a website for a specific use case, such as a CMS for media
publishers, a web-based project tracking tool, or a full-fledged CRM for
non-profit organizations raising money and accepting donations. They can be
distributed as bare installation profiles or as "distributions". Distributions
include Drupal core, the installation profile, and all other required
extensions, such as contributed and custom modules, themes, and third-party
libraries. Bare installation profiles require you to download Drupal Core and
the required extensions separately; place the downloaded profile in the
/profiles directory before you start the installation process.

More about installation profiles and distributions:
 * Read about the difference between installation profiles and distributions:
   https://www.drupal.org/docs/8/distributions/creating-distributions
 * Download contributed installation profiles and distributions:
   https://www.drupal.org/project/distributions
 * Develop your own installation profile or distribution:
   https://www.drupal.org/docs/8/creating-distributions


APPEARANCE
----------

In Drupal, the appearance of your site is set by the theme (themes are
extensions that set fonts, colors, and layout). Drupal core comes with several
themes. More themes are available for download, and you can also create your own
custom theme.

More about themes:
 * Download contributed themes to /themes to modify Drupal's appearance:
   https://www.drupal.org/project/themes
 * Develop your own theme:
   https://www.drupal.org/docs/8/theming


DEVELOPING FOR DRUPAL
---------------------

Drupal contains an extensive API that allows you to add to and modify the
functionality of your site. The API consists of "hooks", which allow modules to
react to system events and customize Drupal's behavior, and functions that
standardize common operations such as database queries and form generation. The
flexible hook architecture means that you should never need to directly modify
the files that come with Drupal core to achieve the functionality you want;
instead, functionality modifications take the form of modules.

When you need new functionality for your Drupal site, search for existing
contributed modules. If you find a module that matches except for a bug or an
additional needed feature, change the module and contribute your improvements
back to the project in the form of a "patch". Create new custom modules only
when nothing existing comes close to what you need.

More about developing:
 * Search for existing contributed modules:
   https://www.drupal.org/project/modules
 * Contribute a patch:
   https://www.drupal.org/patch/submit
 * Develop your own module:
   https://www.drupal.org/developing/modules
 * Follow programming best practices:
   https://www.drupal.org/developing/best-practices
 * Refer to the API documentation:
   https://api.drupal.org/api/drupal/8
 * Learn from documented Drupal API examples:
   https://www.drupal.org/project/examples


MORE INFORMATION
----------------

 * See the Drupal.org online documentation:
   https://www.drupal.org/documentation

 * For a list of security announcements, see the "Security advisories" page at
   https://www.drupal.org/security (available as an RSS feed). This page also
   describes how to subscribe to these announcements via email.

 * For information about the Drupal security process, or to find out how to
   report a potential security issue to the Drupal security team, see the
   "Security team" page at https://www.drupal.org/security-team

 * For information about the wide range of available support options, visit
   https://www.drupal.org and click on Community and Support in the top or
   bottom navigation.

File

core/assets/scaffold/files/drupal.README.txt

View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * About Drupal
  4. * Configuration and features
  5. * Installation profiles
  6. * Appearance
  7. * Developing for Drupal
  8. * More information
  9. ABOUT DRUPAL
  10. ------------
  11. Drupal is an open source content management platform supporting a variety of
  12. websites ranging from personal weblogs to large community-driven websites. For
  13. more information, see the Drupal website at https://www.drupal.org, and join
  14. the Drupal community at https://www.drupal.org/community.
  15. Legal information about Drupal:
  16. * Know your rights when using Drupal:
  17. See LICENSE.txt in the "core" directory.
  18. * Learn about the Drupal trademark and logo policy:
  19. https://www.drupal.com/trademark
  20. CONFIGURATION AND FEATURES
  21. --------------------------
  22. Drupal core (what you get when you download and extract a drupal-x.y.tar.gz or
  23. drupal-x.y.zip file from https://www.drupal.org/project/drupal) has what you
  24. need to get started with your website. It includes several modules (extensions
  25. that add functionality) for common website features, such as managing content,
  26. user accounts, image uploading, and search. Core comes with many options that
  27. allow site-specific configuration. In addition to the core modules, there are
  28. thousands of contributed modules (for functionality not included with Drupal
  29. core) available for download.
  30. More about configuration:
  31. * Install, update, and maintain Drupal:
  32. See INSTALL.txt and UPDATE.txt in the "core" directory.
  33. * Learn about how to use Drupal to create your site:
  34. https://www.drupal.org/documentation
  35. * Follow best practices:
  36. https://www.drupal.org/best-practices
  37. * Download contributed modules to /modules to extend Drupal's functionality:
  38. https://www.drupal.org/project/modules
  39. * See also: "Developing for Drupal" for writing your own modules, below.
  40. INSTALLATION PROFILES
  41. ---------------------
  42. Installation profiles define additional steps (such as enabling modules,
  43. defining content types, etc.) that run after the base installation provided
  44. by core when Drupal is first installed. There are two basic installation
  45. profiles provided with Drupal core.
  46. Installation profiles from the Drupal community modify the installation process
  47. to provide a website for a specific use case, such as a CMS for media
  48. publishers, a web-based project tracking tool, or a full-fledged CRM for
  49. non-profit organizations raising money and accepting donations. They can be
  50. distributed as bare installation profiles or as "distributions". Distributions
  51. include Drupal core, the installation profile, and all other required
  52. extensions, such as contributed and custom modules, themes, and third-party
  53. libraries. Bare installation profiles require you to download Drupal Core and
  54. the required extensions separately; place the downloaded profile in the
  55. /profiles directory before you start the installation process.
  56. More about installation profiles and distributions:
  57. * Read about the difference between installation profiles and distributions:
  58. https://www.drupal.org/docs/8/distributions/creating-distributions
  59. * Download contributed installation profiles and distributions:
  60. https://www.drupal.org/project/distributions
  61. * Develop your own installation profile or distribution:
  62. https://www.drupal.org/docs/8/creating-distributions
  63. APPEARANCE
  64. ----------
  65. In Drupal, the appearance of your site is set by the theme (themes are
  66. extensions that set fonts, colors, and layout). Drupal core comes with several
  67. themes. More themes are available for download, and you can also create your own
  68. custom theme.
  69. More about themes:
  70. * Download contributed themes to /themes to modify Drupal's appearance:
  71. https://www.drupal.org/project/themes
  72. * Develop your own theme:
  73. https://www.drupal.org/docs/8/theming
  74. DEVELOPING FOR DRUPAL
  75. ---------------------
  76. Drupal contains an extensive API that allows you to add to and modify the
  77. functionality of your site. The API consists of "hooks", which allow modules to
  78. react to system events and customize Drupal's behavior, and functions that
  79. standardize common operations such as database queries and form generation. The
  80. flexible hook architecture means that you should never need to directly modify
  81. the files that come with Drupal core to achieve the functionality you want;
  82. instead, functionality modifications take the form of modules.
  83. When you need new functionality for your Drupal site, search for existing
  84. contributed modules. If you find a module that matches except for a bug or an
  85. additional needed feature, change the module and contribute your improvements
  86. back to the project in the form of a "patch". Create new custom modules only
  87. when nothing existing comes close to what you need.
  88. More about developing:
  89. * Search for existing contributed modules:
  90. https://www.drupal.org/project/modules
  91. * Contribute a patch:
  92. https://www.drupal.org/patch/submit
  93. * Develop your own module:
  94. https://www.drupal.org/developing/modules
  95. * Follow programming best practices:
  96. https://www.drupal.org/developing/best-practices
  97. * Refer to the API documentation:
  98. https://api.drupal.org/api/drupal/8
  99. * Learn from documented Drupal API examples:
  100. https://www.drupal.org/project/examples
  101. MORE INFORMATION
  102. ----------------
  103. * See the Drupal.org online documentation:
  104. https://www.drupal.org/documentation
  105. * For a list of security announcements, see the "Security advisories" page at
  106. https://www.drupal.org/security (available as an RSS feed). This page also
  107. describes how to subscribe to these announcements via email.
  108. * For information about the Drupal security process, or to find out how to
  109. report a potential security issue to the Drupal security team, see the
  110. "Security team" page at https://www.drupal.org/security-team
  111. * For information about the wide range of available support options, visit
  112. https://www.drupal.org and click on Community and Support in the top or
  113. bottom navigation.

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