Browse Source

Updated readme and install guide

sh4nks 10 years ago
parent
commit
c1f3223f3c
2 changed files with 15 additions and 9 deletions
  1. 7 4
      README.md
  2. 8 5
      docs/installation.rst

+ 7 - 4
README.md

@@ -7,18 +7,18 @@
 using the micro framework Flask.
 
 
-**_Note:_** I'm doing my exchange semester and most of the time I'm busy with traveling and such :). The project is not dead in any way - I'm just really busy.
-
-
 ## FEATURES
 
 * A Bulletin Board like FluxBB or DjangoBB in Flask
 * Private Messages
 * Admin Interface
 * Group based permissions
-* BBCode support
+* BBCode Support
 * Topic Tracker
 * Unread Topics/Forums
+* i18n Support
+* Completely Themeable
+* Plugin System
 
 
 ## TODO
@@ -28,6 +28,9 @@ using the micro framework Flask.
 
 ## INSTALLATION
 
+For a complete installation guide please visit the installation documentation
+[here](https://flaskbb.readthedocs.org/en/latest/installation.html).
+
 * Create a virtualenv
 * Install the dependencies
     * `pip install -r requirements.txt`

+ 8 - 5
docs/installation.rst

@@ -166,20 +166,23 @@ To test if everything has worked, run the development server with
 Production
 ~~~~~~~~~~
 
-Now, you should be able to install `FlaskBB` and can run therefore
+Now, you can start the installation process with
 ::
 
     python manage.py initflaskbb
 
-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).
+During the installation process you are asked about your username,
+your email address and the password for your administrator user.
 
 
 Upgrading
 ---------
 
-`A upgrade guide will be written when first stable version is released.`
+If the database models changed after a release, you have to run the ``upgrade``
+command
+::
+
+    python manage.py db upgrade
 
 
 Deploying