Browse Source

Improve README

sh4nks 8 years ago
parent
commit
a74a948478
3 changed files with 23 additions and 20 deletions
  1. 5 1
      Makefile
  2. 17 18
      README.md
  3. 1 1
      flaskbb/cli/main.py

+ 5 - 1
Makefile

@@ -3,6 +3,7 @@
 help:
 	@echo "  clean      remove unwanted stuff"
 	@echo "  install    install dependencies and flaskbb"
+	@echo "  devconfig  generates a development config"
 	@echo "  test       run the testsuite"
 	@echo "  run        run the development server with the development config"
 	@echo "  docs       build the documentation"
@@ -22,9 +23,12 @@ test:
 run:
 	flaskbb --config ./flaskbb.cfg run
 
+devconfig:
+	flaskbb makeconfig -d
+
 install:dependencies
 	clear
-	flaskbb install
+	flaskbb --config ./flaskbb.cfg install
 
 docs:
 	$(MAKE) -C docs html

+ 17 - 18
README.md

@@ -1,17 +1,14 @@
+# FlaskBB
+
 [![Build Status](https://travis-ci.org/sh4nks/flaskbb.svg?branch=master)](https://travis-ci.org/sh4nks/flaskbb)
 [![Coverage Status](https://coveralls.io/repos/sh4nks/flaskbb/badge.png)](https://coveralls.io/r/sh4nks/flaskbb)
 [![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
-
-[FlaskBB](http://flaskbb.org) is a forum software written in python
-using the micro framework Flask.
+*FlaskBB is a Forum Software written in Python using the micro framework Flask.*
 
+Currently, following features are implemented:
 
-## Features
-
-* A Bulletin Board like FluxBB or DjangoBB in Flask
 * Private Messages
 * Admin Interface
 * Group based permissions
@@ -23,32 +20,34 @@ using the micro framework Flask.
 * Plugin System
 * Command Line Interface
 
+Checkout the [FlaskBB Forums](https://forums.flaskbb.org) to see an actual
+running instance of FlaskBB. Use demo//demo as login for the test user.
+
 
 ## Quickstart
 
 For a complete installation guide please visit the installation documentation
 [here](https://flaskbb.readthedocs.org/en/latest/installation.html).
 
+This is how you set up an development instance of FlaskBB:
+
 * Create a virtualenv
-* Configuration (_adjust them accordingly to your needs_)
-    * For development copy `flaskbb/configs/development.py.example` to `flaskbb/configs/development.py`
+* Configuration
+    * `make devconfig`
 * Install dependencies and FlaskBB
     * `make install`
 * Run the development server
     * `make run`
-* Visit [localhost:8080](http://localhost:8080)
-
-
-## Documentation
-
-The documentation is located [here](http://flaskbb.readthedocs.org/en/latest/).
+* Visit [localhost:5000](http://localhost:5000)
 
 
 ## License
 
-[BSD LICENSE](http://flask.pocoo.org/docs/license/#flask-license)
+FlaskBB is licensed under the [BSD License](https://github.com/sh4nks/flaskbb/blob/master/LICENSE).
 
 
-## Acknowledgements
+# Links
 
-[/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!
+* [Project Website](https://flaskbb.org)
+* [Documentation](https://flaskbb.readthedocs.io)
+* [Source Code](https://github.com/sh4nks/flaskbb)

+ 1 - 1
flaskbb/cli/main.py

@@ -435,7 +435,7 @@ def generate_config(development, output, force):
 
     default_conf = {
         "is_debug": True,
-        "server_name": "localhost",
+        "server_name": "localhost:5000",
         "url_scheme": "http",
         "database_uri": "sqlite:///" + os.path.join(
             os.path.dirname(current_app.root_path), "flaskbb.sqlite"),