Updating installation instructions (ref #19)

holmes-app · Apr 30, 2014 · 8a19f28 · 8a19f28
1 parent 158531d
commit 8a19f28
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 16 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+Contributing
+============
+
+Installation
+------------
+
+Installation instructions for development enviroments.
+
+### Requirements
+
+The holmes-api requires the following tools to work:
+
+* MySQL
+* Python
+* python-pip
+* Redis
+
+### Installation
+
+The holmes-api software has a Makefile to help with common tasks. To install, just type:
+
+    make setup
+
+To install data/migrations:
+
+    make data
diff --git a/README.md b/README.md
@@ -9,21 +9,8 @@ Waffle
 
 https://waffle.io/holmes-app/holmes-api
 
-Requirements
-------------
-
-* MySQL
-* Python
-* python-pip
-* Redis
-
-How to install
---------------
 
-The holmes-api software has a Makefile to help with common tasks. To install, just type:
-
-    make setup
-
-To install data/migrations:
+Contributing
+------------
 
-    make data
+See [CONTRIBUTING.md](/CONTRIBUTING.md) if you want to contribute to holmes-api, the document also have installation instruction for development enviroments.