CRM-19384 - Update developer links and change readme to markdown (#9077)
authorcolemanw <coleman@civicrm.org>
Wed, 21 Sep 2016 16:38:06 +0000 (12:38 -0400)
committerGitHub <noreply@github.com>
Wed, 21 Sep 2016 16:38:06 +0000 (12:38 -0400)
* CRM-19384 - Update developer links and change readme to markdown

* Add icon

README.md [moved from README.txt with 73% similarity]

similarity index 73%
rename from README.txt
rename to README.md
index 147b0df3ae829de39ee58c1414839466b8ce3fd4..fc7a89b852d1cbb2847bee884a3c19b3106a5f56 100644 (file)
+++ b/README.md
@@ -1,17 +1,9 @@
-*************************
-README file for CiviCRM
-*************************
-1. About
-2. Installation
-3. Documentation
-4. Support
-5. Development
+![](i/logo_lg.png) Welcome to CiviCRM
+=====================================
 
+About
+-----
 
-
-*************************
-1. About
-*************************
 CiviCRM is a constituent relationship management system designed to
 meet the needs of advocacy, non-profit and non-governmental groups.
 It is an open source project, licensed under GNU AGPL 3, and
@@ -21,20 +13,19 @@ CiviCRM is released as a module that runs within the Drupal, Joomla,
 and WordPress content management systems.
 
 
-*************************
-2. Installation
-*************************
-The download URLs and installation instructions are available on our
-website:
+Installation
+------------
+
+The download URLs and installation instructions are available on our website:
 https://civicrm.org/download
 
 Installation instruction can be found on the wiki:
 http://wiki.civicrm.org/
 
 
-*************************
-3. Documentation
-*************************
+Documentation
+-------------
+
 Documentation, as well as the project bug tracker and mailing lists,
 can be found at https://civicrm.org/ Just click on the appropriate link.
 
@@ -42,9 +33,9 @@ Our main documentation site is the CiviCRM wiki:
 http://wiki.civicrm.org/
 
 
-*************************
-4. Support
-*************************
+Support
+-------
+
 Answers for users, administrators & integrators:
 http://civicrm.stackexchange.com
 
@@ -52,9 +43,9 @@ Paid support available from
 https://civicrm.org/providers
 
 
-*************************
-5. Development
-*************************
+Development
+-----------
+
 Developers are highly encouraged to join the CiviCRM forums and post
 questions and ideas on the Developer Discussion board:
 http://forum.civicrm.org/index.php/board,20.0.html