X-Git-Url: https://code.wpia.club/?a=blobdiff_plain;f=README.md;h=1181181cdcd7fa71104bad99afd76cc48741c264;hb=e459f85797c9ace2a9367294a5be7435533d3d37;hp=3b33b93b8964cc5634335a6856bbf219fad2c769;hpb=411519c22621b586a6dbb9ec6bc2e5e1bc020897;p=motion.git diff --git a/README.md b/README.md index 3b33b93..1181181 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,28 @@ pip install -r requirements.txt ``` Then edit config.py.example into config.py with your database connection -To debug-run: +To debug-run linux: ``` LANG=C.UTF-8 FLASK_DEBUG=1 FLASK_APP=motion.py flask run ``` +To debug-run windows: +``` +set LANG=C.UTF-8 +set FLASK_DEBUG=1 +set FLASK_APP=motion.py +flask run +``` + +For unit testing use config values from config.py.example: +``` +python -m unittest tests/test_motion.py +``` + The database schema is automatically installed when the table "schema_version" does not exist and the application is started. + +# Usage + +Within the motion content markdown can be used for formatting e.g. +* To add a line break add two lines +* to enter a link use `[text](https//domain.tld/link)`