Updated docs

README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/sh4nks/flaskbb.svg?branch=master)](https://travis-ci.org/sh4nks/flaskbb)
+
 # INTRODUCTION
 
 [FlaskBB](http://flaskbb.org) is a forum software written in python
@@ -6,7 +8,7 @@ using the micro framework Flask.
 
 ## FEATURES
 
-* A Bulletin Board like FluxBB, DjangoBB in Flask
+* A Bulletin Board like FluxBB or DjangoBB in Flask
 * Private Messages
 * Admin Interface
 * Group based permissions
@@ -20,71 +22,23 @@ using the micro framework Flask.
 * See the github [issues](https://github.com/sh4nks/flaskbb/issues?state=open)
 
 
-## DEPENDENCIES
-
-* [Flask](http://flask.pocoo.org)
-    * [Werkzeug](http://werkzeug.pocoo.org)
-    * [Jinja2](http://jinja.pocoo.org)
-* [Flask-SQLAlchemy](http://pythonhosted.org/Flask-SQLAlchemy/)
-    * [SQLAlchemy](http://www.sqlalchemy.org/)
-* [Flask-WTF](http://pythonhosted.org/Flask-WTF/)
-    * [WTForms](http://wtforms.simplecodes.com/docs/1.0.4/)
-* [Flask-Login](http://flask-login.readthedocs.org/en/latest/)
-* [Flask-Mail](http://pythonhosted.org/flask-mail/)
-* [Flask-Script](http://flask-script.readthedocs.org/en/latest/)
-* [Flask-Themes2](http://flask-themes2.rtfd.org/)
-* [Flask-Migrate](http://flask-migrate.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 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`
-    * **NOTE**: If you are using pip 1.5 you need to add these parameters: ``--allow-external postmarkup --allow-unverified postmarkup``
 * Configuration (_adjust them accordingly to your needs_)
     * For development copy `flaskbb/configs/development.py.example` to `flaskbb/configs/development.py`
-    * For production copy `flaskbb/configs/production.py.example` to `flaskbb/configs/production.py`
 * Database creation
-    * **Development:** Create the database with some example content
-        * `python manage.py createall`
-    * **Production:** Create the database and the admin user
-        * `python manage.py initflaskbb`
+    * `python manage.py createall`
 * Run the development server
     * `python manage.py runserver`
 * Visit [localhost:8080](http://localhost:8080)
 
 
-## Upgrading
+## DOCUMENTATION
 
-* Upgrading from a previous installation
-    * Pull the latest changes from the repository
-    * `git pull`
-* See if the example config has changed and adjust the settings to your needs
-    * `diff flaskbb/configs/production.py flaskbb/configs/production.py.example`
-    * `$EDITOR flaskbb/configs/production.py`
-* Upgrade the database to the latest revision
-    * `python manage.py db upgrade head`
+The documentation is located [here](http://flaskbb.readthedocs.org/en/latest/).
 
 
 ## LICENSE
@@ -94,4 +48,4 @@ using the micro framework Flask.
 
 ## ACKNOWLEDGEMENTS
 
-[/r/flask](http://reddit.com/r/flask), [Flask](http://flask.pocoo.org) and it's [extensions](http://flask.pocoo.org/extensions/).
+[/r/flask](http://reddit.com/r/flask), [Flask](http://flask.pocoo.org), it's [extensions](http://flask.pocoo.org/extensions/) and everyone who has helped me!

docs/installation.rst

@@ -157,16 +157,36 @@ Local SMTP Server
 Installation
 ============
 
+
+Development
+~~~~~~~~~~~
+
+For development you can create the database with the command below. This will
+additional to the database also create a few users with some example content.
+::
+
+    python manage.py createall
+
+To test if everything has worked, run the development server with
+``python manage.py runserver``.
+
+Production
+~~~~~~~~~~
+
 Now, you should be able to install `FlaskBB` and can run therefore
 ::
 
     python manage.py initflaskbb
 
-Here you are asked about what your username is, which email adress you use
-and last but not least, which password your admin user has (please choose a secure one).
+There you are going to be asked about your username, your email adress
+and which password you want to use for your admin user
+(please choose a secure one).
 
-To test if everything worked, run the development server with
-``python manage.py runserver``.
+
+Upgrading
+=========
+
+`A upgrade guide will be written when first stable version is released.`
 
 
 Deploying