sh4nks 11 лет назад
Родитель
Сommit
aff85ca3d1
1 измененных файлов с 40 добавлено и 8 удалено
  1. 40 8
      README.md

+ 40 - 8
README.md

@@ -18,10 +18,18 @@ using the micro framework Flask.
 
 ## TODO
 
-* A own theme and make FlaskBB themable with Flask-Themes2
-* Localization (Babel)
-* Searching for members, posts,...
-* Figure out how to integrate it in another app where you can use the models from flaskbb and so on..
+* **High Priority**:
+    * Searching for members, posts,...
+    * Move the topic in another forum
+    * Fixing all bugs I encounter during development
+* **Medium Priority**:
+    * Database migrations
+    * A own theme and make FlaskBB themable with Flask-Themes2
+    * Localization (Babel)
+    * Polls - I definitely want this! :)
+* **Low Priority**:
+    * Learn how to create a Plugin API so other developers can create plugins for FlaskBB
+    * Figure out how to integrate it in another app
 
 
 ## DEPENDENCIES
@@ -37,14 +45,38 @@ using the micro framework Flask.
 * [Flask-Mail](http://pythonhosted.org/flask-mail/)
 * [Flask-Script](http://flask-script.readthedocs.org/en/latest/)
 
+### OPTIONAL DEPENDENCIES
+* [Pygmens](http://pygments.org/) - For code highlighting
+* [Redis](http://redis.io/) - For counting the online guests
+
 
 ## INSTALLATION
 
 * Create a virtualenv
-* Install the dependencies with `pip install -r requirements.txt`
-* Copy `flaskbb/configs/development.py.example` to `flaskbb/configs/development.py`
-* Create the database with some example content `python manage.py createall`
-* Run the development server `python manage.py runserver`
+    * Install virtualenvwrapper with your package manager or via
+        * `sudo pip install virtualenvwrapper`
+
+    * Add these lines to your `.bashrc`
+
+            export WORKON_HOME=$HOME/.virtualenvs  # Location for your virtualenvs
+            source /usr/local/bin/virtualenvwrapper.sh
+
+    * Create a new virtualenv
+        * `mkvirtualenv -a /path/to/flaskbb -p $(which python2) flaskbb`
+
+    * and finally activate it
+        * `workon flaskbb`
+
+    * For more options visit the documentation [here](http://virtualenvwrapper.readthedocs.org/en/latest/index.html).
+
+* Install the dependencies
+    * `pip install -r requirements.txt`
+* Create the development config
+    * `cp flaskbb/configs/development.py.example flaskbb/configs/development.py`
+* Create the database with some example content
+    * `python manage.py createall`
+* Run the development server
+    * `python manage.py runserver`
 * Visit [localhost:8080](http://localhost:8080)
 
 ## LICENSE