Merge pull request #6928 from totten/master-docs
[civicrm-core.git] / README.txt
1 *************************
2 README file for CiviCRM
3 *************************
4 1. About
5 2. Installation
6 3. Documentation
7 4. Support
8 5. Development
9
10
11
12 *************************
13 1. About
14 *************************
15 CiviCRM is a constituent relationship management system designed to
16 meet the needs of advocacy, non-profit and non-governmental groups.
17 It is an open source project, licensed under GNU AGPL 3, and
18 coordinated by CiviCRM LLC. The project website is https://civicrm.org/
19
20 CiviCRM is released as a module that runs within the Drupal, Joomla,
21 and WordPress content management systems.
22
23
24 *************************
25 2. Installation
26 *************************
27 The download URLs and installation instructions are available on our
28 website:
29
30 https://civicrm.org/download
31
32 Installation instruction can be found on the wiki:
33 http://wiki.civicrm.org/
34
35
36 *************************
37 3. Documentation
38 *************************
39 Documentation, as well as the project bug tracker and mailing lists,
40 can be found at https://civicrm.org/ Just click on the appropriate link.
41
42 Our main documentation site is the CiviCRM wiki:
43 http://wiki.civicrm.org/
44
45
46 *************************
47 4. Support
48 *************************
49 Answers for users, administrators & integrators:
50 http://civicrm.stackexchange.com
51
52 Paid support available from
53 https://civicrm.org/providers
54
55
56 *************************
57 5. Development
58 *************************
59 Developers are highly encouraged to join the CiviCRM forums and post
60 questions and ideas on the Developer Discussion board:
61 http://forum.civicrm.org/index.php/board,20.0.html
62
63 Installing the latest developmental code requires some special steps. Full
64 instructions are on the wiki:
65 http://wiki.civicrm.org/confluence/display/CRMDOC/Github+for+CiviCRM
66
67 Report all issues to CiviCRM via JIRA:
68 https://issues.civicrm.org