From d93b1141d743f00dcb1adfbb77913bd27fecda50 Mon Sep 17 00:00:00 2001
From: lemoer <git@irrelefant.net>
Date: Sun, 29 Dec 2024 00:42:11 +0100
Subject: [PATCH] README: add info how to create a task

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index bab9c66..774831d 100644
--- a/README.md
+++ b/README.md
@@ -63,3 +63,26 @@ Change the ownership of the db, such that the host user 1000 can write it:
 ```
 sudo chown -R 1000 data/
 ```
+
+Install venv outside of docker:
+```
+pip -m venv venv
+. venv/bin/activate
+pip install -r requirements.txt
+```
+
+### Creating a task
+
+Create a task:
+```
+python create_task.py "Küche aufräumen" 3 "in 40 minutes" --pad-template-url "https://pad.leinelab.org/bEvDjtyyQIGgZso_B7RIpw"
+```
+
+This:
+- Creates a task called "Küche aufräumen".
+- Requests 3 people from the base group for it.
+- The task starts in 40 minutes.
+- A detailed description of the tasks is found in the hedgedoc pad with url https://pad.leinelab.org/bEvDjtyyQIGgZso_B7RIpw. It will be used as a template for a new pad.
+
+Implicitly, this means:
+- People have 1 day to answer their participation requests for the task until the next person is asked. If a different timeout is desired, `--timeout-seconds X` can be specified for the task creation.