Skip to content
Browse files

Better README, removed unused dependencies

  • Loading branch information...
1 parent d5266b4 commit f42225295746c6ed96f79b0355d07bedfeb65ee8 @ekzhu ekzhu committed Feb 21, 2013
Showing with 36 additions and 7 deletions.
  1. +1 −0 .gitignore
  2. +33 −0 README.md
  3. +0 −4 README.rst
  4. +2 −3 conf/reqs-dev.txt
View
1 .gitignore
@@ -22,3 +22,4 @@ data/
etc/
june/_static/sea-modules/
+venv
View
33 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
View
4 README.rst
@@ -1,4 +0,0 @@
-June
-=======
-
-June is a forum, and this version is based on Flask.
View
5 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

0 comments on commit f422252

Please sign in to comment.
Something went wrong with that request. Please try again.