README.txt 5.75 KB
Newer Older
1 2 3 4 5 6

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

 * About Drupal
 * Configuration and features
7
 * Installation profiles
8 9
 * Appearance
 * Developing for Drupal
10
 * More information
11 12 13 14 15 16

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
17 18
more information, see the Drupal website at https://www.drupal.org, and join
the Drupal community at https://www.drupal.org/community.
19 20 21

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

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

29
Drupal core (what you get when you download and extract a drupal-x.y.tar.gz or
30 31 32 33 34
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
35 36
thousands of contributed modules (for functionality not included with Drupal
core) available for download.
37 38

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

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69

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:
70
 * Read about the difference between installation profiles and distributions:
71
   https://www.drupal.org/node/1089736
72
 * Download contributed installation profiles and distributions:
73
   https://www.drupal.org/project/distributions
74
 * Develop your own installation profile or distribution:
75
   https://www.drupal.org/developing/distributions
76 77


78 79 80 81 82
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
83 84
themes. More themes are available for download, and you can also create your own
custom theme.
85 86

More about themes:
87
 * Download contributed themes to /themes to modify Drupal's appearance:
88
   https://www.drupal.org/project/themes
89
 * Develop your own theme:
90
   https://www.drupal.org/documentation/theme
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

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:
111
   https://www.drupal.org/project/modules
112
 * Contribute a patch:
113
   https://www.drupal.org/patch/submit
114
 * Develop your own module:
115
   https://www.drupal.org/developing/modules
116
 * Follow programming best practices:
117
   https://www.drupal.org/developing/best-practices
118
 * Refer to the API documentation:
119
   https://api.drupal.org/api/drupal/8
120 121
 * Learn from documented Drupal API examples:
   https://www.drupal.org/project/examples
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139

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.