Merge branch 'rework-runs'

[hubacji1/coffee-getter.git] / README.md

diff --git a/README.md b/README.md
index a6bf09d2cb8880ccdc09157587fa052824d0638b..e081a52422259b15750978e714405e409b57330e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,59 @@
-# Coffeebot getter
-Somehow friendly API to get and share coffee related data from database.
+Coffee getter is somehow friendly API to get and share coffee related data from
+the database.
 
-# Contribute
-## Code
-For quick orientation see the [changelog][1].
+This project is published under [GNU AGPLv3 license](./LICENSE).
 
-Please, think about [The seven rules of a great Git commit message][2] when
-making commit. The project use [OneFlow][3] branching model with the `master`
-branch as the branch where the development happens.
 
-## License
-This project is developed under [GNU GPLv3 license][4].
+## Running tasks periodically
+Please, see [Timers][6] and [User][7] pages about systemd.
 
-[1]: ./CHANGELOG.md
-[2]: https://chris.beams.io/posts/git-commit/
-[3]: http://endoflineblog.com/oneflow-a-git-branching-model-and-workflow
-[4]: ./LICENSE
+Service example:
 
+    [Unit]
+    Description=Run top 5 Mate drinkers stats
+
+    [Service]
+    Environment=PYTHONPATH=/path/to/coffee-getter
+    ExecStart=/path/to/coffee-getter/run/top5_mate_stats.py
+
+Timer example:
+
+    [Unit]
+    Description=Run top 5 Mate drinkers stats each Mon 9am
+
+    [Timer]
+    OnCalendar=Mon *-*-* 09:00:00
+    Persistent=true
+
+    [Install]
+    WantedBy=timers.target
+
+Store both files in:
+
+    ~/.config/systemd/user/
+
+Enable timer and service:
+
+    systemctl --user enable top5_mate_stats.timer
+    systemctl --user enable top5_mate_stats.service
+
+Start the timer:
+
+    systemctl --user start top5_mate_stats.timer
+
+
+## Contribute
+Use Test Driven Development. Run test with:
+
+    python3 -m unittest discover ut
+
+Send patches with git-send-email:
+
+    git config format.subjectPrefix "PATCH coffee-getter"
+    git config sendemail.to "jiri.vlasak.2@cvut.cz"
+
+You need the database for the development. You may create it by:
+
+    python3 -c '
+        from ut.test_db import create_test_db
+        create_test_db("coffee.db")'