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

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

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

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

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

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

28
Drupal core (what you get when you download and extract a drupal-x.y.tar.gz or
29
drupal-x.y.zip file from https://drupal.org/project/drupal) has what you need to
30 31 32 33 34 35
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.
36 37 38

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

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

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


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

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

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:
110
   https://drupal.org/project/modules
111
 * Contribute a patch:
112
   https://drupal.org/patch/submit
113
 * Develop your own module:
114 115 116
   https://drupal.org/developing/modules
 * Follow programming best practices:
   https://drupal.org/developing/best-practices
117
 * Refer to the API documentation:
118
   https://api.drupal.org/api/drupal/8