From bc7ab19e8618d9fb2dd7e3031d211d278e37ef36 Mon Sep 17 00:00:00 2001 From: Skia Date: Fri, 29 Jan 2016 16:29:24 +0100 Subject: [PATCH] Update README --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 20fa636b..a635bc72 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ ## Sith AE +### Get started To start working on the project, just run the following commands: @@ -10,16 +11,17 @@ To start working on the project, just run the following commands: pip install -r requirements.txt ./manage.py setup -To load some initial data in the core: +To start the simple development server, just run `python3 manage.py runserver` - python3 manage.py loaddata users groups pages +### Generating documentation -You will be prompted for your Gitlab account, so you need some. +There is a Doxyfile at the root of the project, meaning that if you have Doxygen, you can run `doxygen Doxyfile` to +generate a complete HTML documentation that will be available in the *./doc/html/* folder. -To start the debug server, just run `python3 manage.py runserver` - -#### Dependencies: +### Dependencies: * Django 1.8 + * Pillow + +The development is done with sqlite, but it is advised to set a more robust DBMS for production (Postgresql for example) + -The development is done with sqlite, but it is advised to set a more robust -DBMS for production (Postgresql for example)