[chronojump-server] README File with some instructions



commit 63a2ec8cab72ff796daa86f54acb8501a4e214e4
Author: Marcos Venteo <mventeo gmail com>
Date:   Mon Jun 12 23:22:48 2017 +0200

    README File with some instructions

 README.md |   37 ++++++++++++++++++++++++++++++++++++-
 1 files changed, 36 insertions(+), 1 deletions(-)
---
diff --git a/README.md b/README.md
old mode 100644
new mode 100755
index 3ff145a..f1db1cb
--- a/README.md
+++ b/README.md
@@ -1 +1,36 @@
-Testing API server for chronojump (http://www.chronojump.org)
+# Chronojump Server
+
+Chronojump server ...
+
+## 1. How to use
+
+Create a virtual enviroment and activate the enviroment
+```
+$ source venv\bin\activate
+```
+
+Install dependencies with pip
+```
+$ pip install -r requirements.txt
+```
+
+Install the chronojump-server packaged and run the server
+```
+$ pip install -e .
+$ flask run
+```
+
+## 2. Database
+Database is created the first time the server is running, the only requirement
+is to have the database previously created in MySQL and well configured in
+configuration file. See config below
+
+To populate with some random data execute the following
+```
+$ flask populate_test_data
+```
+
+## 3. Config file
+TBW
+
+## 4. License


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]