Changeset 89b0616 in flowtimer

Timestamp:

08/29/24 19:21:35 (9 months ago)

Author:

Enrico Schwass <ennoausberlin@…>

Branches:

guix

Children:

794b5c2

Parents:

43d78ee

Message:

README updated

File:

• README.md (modified) (2 diffs)

README.md

@@ -112 +112 @@
 ```
 
-This configuration represents a standard Pomodoro cycle: three work sessions of 25 minutes each, separated by 5-minute short breaks, and followed by a 15-minute long break.
+This configuration represents a standard schedule named 'default':
+
+It starts with a 15 min (900s) morning huddle, followed by a sequence 'AM' consisting of 'Tasking', 'Working', 'Syncing', that is repeated twice.
+    
+After a 45 min lunch break, another sequence 'PM' follows, that is repeated twice as well.
+
+Color schemes can be configured as follows. Use the phase title as title for each color scheme to match them.
+
+
+```json
+{
+    "color_schemes": [
+        {
+            "title": "Completed",
+            "widget": "red",
+            "sequence_label": "red",
+            "center_frame": "red"
+        },
+        {
+            "title": "Huddle",
+            "widget": "blue",
+            "sequence_label": "red",
+            "center_frame": "yellow"
+        },
+        {
+            "title": "Tasking",
+            "widget": "red",
+            "sequence_label": "yellow",
+            "center_frame": "blue"
+        },
+        {
+            "title": "Work",
+            "widget": "yellow",
+            "sequence_label": "blue",
+            "center_frame": "red"
+        },
+        {
+            "title": "Break",
+            "widget": "green",
+            "sequence_label": "brown",
+            "center_frame": "white"
+        },
+        {
+            "title": "Start",
+            "widget": "white",
+            "sequence_label": "green",
+            "center_frame": "brown"
+        },
+        {
+            "title": "Default",
+            "widget": "pink",
+            "sequence_label": "orange",
+            "center_frame": "violet"
+        }
+    ]
+}
+```
 
 2. **Run Flowtimer:**
@@ -128 +184 @@
 
 - `--config <file>`: Specify a custom JSON configuration file.
-- `--start`: Start the Pomodoro timer with the current configuration.
-
+- `--colors`: Specify a JSON color scheme configuration file.
+- `--start`: Autostart the timer with the current configuration.
 ### Example
 
 ```bash
-python3 flowtimer.py --config myconfig.json
+python3 flowtimer.py --config myschedule.json --colors mycolorscheme.json
 ```
 
-This command will start Flowtimer with a custom configuration provided in `myconfig.json`.
+This command will start Flowtimer with a custom configuration provided in `myschedule.json` using color scheme from mycolorscheme.json.
 
 ## Contributing