Better README, removed unused dependencies

lepture · Feb 21, 2013 · f422252 · f422252
1 parent d5266b4
commit f422252
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,4 @@ data/
 etc/
 
 june/_static/sea-modules/
+venv
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+June
+=====
+
+This is a forum project.
+
+Before start:
+-------------
+
+Make sure you have python2.7, pip and virtualenv installed.
+
+Development
+-----------
+
+To start development server:
+
+    $ git checkout https://github.com/ekzhu/june.git
+    $ cd june
+    $ virtualenv --distribute venv
+    $ source venv/bin/activate
+    (venv)$ pip install -r conf/reqs-dev.txt
+    (venv)$ python manager.py creatdb
+    (venv)$ python manager.py runserver
+
+It should be running at localhost:5000.
+
+Trouble shooting
+----------------
+
+If you encounter build failure when trying to install gevent and get error saying "event.h" not found. You need to install libevent before installing gevent again. 
+
+On Mac OS X with homebrew, you can simply do:
+
+    brew install libevent
diff --git a/README.rst b/README.rst
diff --git a/conf/reqs-dev.txt b/conf/reqs-dev.txt
@@ -3,11 +3,10 @@
 Flask
 misaka
 pygments
-gevent
+gevent==0.13.8
 
 # database
 Flask-SQLAlchemy
-MySQL-python
 
 # cache support
 Flask-Cache
@@ -40,4 +39,4 @@ nose-cov
 flake8
 
 # documentation
-sphinx
+#sphinx