Browse Source

Adapt flaskbb installation docs

sh4nks 8 years ago
parent
commit
3e42992826
3 changed files with 16 additions and 19 deletions
  1. 2 1
      Makefile
  2. 7 12
      README.md
  3. 7 6
      docs/installation.rst

+ 2 - 1
Makefile

@@ -2,7 +2,7 @@
 
 help:
 	@echo "  clean      remove unwanted stuff"
-	@echo "  install    install flaskbb and setup"
+	@echo "  install    install dependencies and flaskbb"
 	@echo "  test       run the testsuite"
 	@echo "  run        run the development server"
 	@echo "  docs       build the documentation"
@@ -25,6 +25,7 @@ run:
 install:dependencies
 	clear
 	pip install -e .
+	flaskbb install
 
 docs:
 	$(MAKE) -C docs html

+ 7 - 12
README.md

@@ -3,13 +3,13 @@
 [![Code Health](https://landscape.io/github/sh4nks/flaskbb/master/landscape.svg?style=flat)](https://landscape.io/github/sh4nks/flaskbb/master)
 [![License](https://img.shields.io/badge/license-BSD-blue.svg)](https://flaskbb.org)
 
-# INTRODUCTION
+# Introduction
 
 [FlaskBB](http://flaskbb.org) is a forum software written in python
 using the micro framework Flask.
 
 
-## FEATURES
+## Features
 
 * A Bulletin Board like FluxBB or DjangoBB in Flask
 * Private Messages
@@ -23,12 +23,7 @@ using the micro framework Flask.
 * Plugin System
 
 
-## TODO
-
-* See the github [issues](https://github.com/sh4nks/flaskbb/issues?state=open)
-
-
-## INSTALLATION
+## Quickstart
 
 For a complete installation guide please visit the installation documentation
 [here](https://flaskbb.readthedocs.org/en/latest/installation.html).
@@ -39,20 +34,20 @@ For a complete installation guide please visit the installation documentation
 * Install dependencies and FlaskBB
     * `make install`
 * Run the development server
-    * `make runserver`
+    * `make run`
 * Visit [localhost:8080](http://localhost:8080)
 
 
-## DOCUMENTATION
+## Documentation
 
 The documentation is located [here](http://flaskbb.readthedocs.org/en/latest/).
 
 
-## LICENSE
+## License
 
 [BSD LICENSE](http://flask.pocoo.org/docs/license/#flask-license)
 
 
-## ACKNOWLEDGEMENTS
+## Acknowledgements
 
 [/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!

+ 7 - 6
docs/installation.rst

@@ -23,14 +23,14 @@ For example, on archlinux you can install it with
 
     $ sudo pacman -S python2-virtualenvwrapper
 
-or, if you own a Mac, you can simply install it with
+or, if you own a Mac, you can install it with
 ::
 
     $ sudo pip install virtualenvwrapper
 
 For more information checkout the  `virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/en/latest/install.html#basic-installation>`_ installation.
 
-After that you can create your virtualenv with
+After that, you can create your virtualenv with
 ::
 
     $ mkvirtualenv -a /path/to/flaskbb -p $(which python2) flaskbb
@@ -160,12 +160,13 @@ For a guided install, run
 
     $ make install
 
-or:
+or
+::
 
-    python manage.py install
+    flaskbb install
 
 During the installation process you are asked about your username,
-your email address and the password for your administrator user. Using the 
+your email address and the password for your administrator user. Using the
 `make install` command is recommended as it checks that the dependencies are also
 installed.
 
@@ -177,7 +178,7 @@ If the database models changed after a release, you have to run the ``upgrade``
 command
 ::
 
-    python manage.py db upgrade
+    flaskbb db upgrade
 
 
 Deploying