README.md

   1 # Installation
   2 Requires 3.
   3 To install:
   4 ```
   5 virtualenv -p python3 .
   6 . bin/activate
   7 pip install -r requirements.txt
   8 ```
   9 Then edit config.py.example into config.py with your database connection
  10
  11 To debug-run linux:
  12 ```
  13 LANG=C.UTF-8 FLASK_DEBUG=1 FLASK_APP=motion.py flask run
  14 ```
  15
  16 To debug-run windows:
  17 ```
  18 set LANG=C.UTF-8
  19 set FLASK_DEBUG=1
  20 set FLASK_APP=motion.py
  21 flask run
  22 ```
  23
  24 For unit testing use config values from config.py.example:
  25 ```
  26 python -m unittest tests/test_motion.py
  27 ```
  28
  29 The database schema is automatically installed when the table "schema_version" does not exist and the application is started.
  30
  31 # Usage
  32
  33 Within the motion content markdown can be used for formatting e.g.
  34 * To add a line break add two lines
  35 * to enter a link use `[text](https//domain.tld/link)`