Changeset c251a80 in flowtimer for README.md

Timestamp:

08/29/24 15:21:23 (9 months ago)

Author:

Enrico Schwass <ennoausberlin@…>

Branches:

guix

Children:

80996d0

Parents:

7a52e57

Message:

command line argument parser added and README.md updated

File:

• README.md (modified) (4 diffs)

README.md

@@ -18 +18 @@
 - Python 3.x
 
+### Test without install
+   ```bash
+   git clone --branch guix https://gitlab.kid.local:/legacy/flowtimer.git
+   cd flowtimer
+
+   guix shell python python:tk python-pillow --
+   export PYTHONPATH=$PYTHONPATH:./
+   python3 flowtimer/main.py
+   ```
+
 ### Installation
 
 1. Clone the repository:
    ```bash
-   git clone --branch guix https://gitlab.kid.local:/legacy/flowtimer.git
-   cd flowtimer
+    git clone --branch guix https://gitlab.kid.local:/legacy/flowtimer.git
+        cd flowtimer
    ```
+2. Install the app and required dependencies
+   ```bash
+        pip3 install .
 
-2. Install the required dependencies:
-   ```bash
-   pip3 install .
    ```
-
 ### Usage
 
@@ -101 +110 @@
 2. **Run Flowtimer:**
    ```bash
-   python flowtimer.py --config /path/to/config_file.json
+   python3 flowtimer.py --start --config /path/to/config_file.json
    ```
 
@@ -109 +118 @@
    To change the timings or the order of phases, simply edit the JSON file and rerun the script.
 
-### Default Configuration
-
-If no configuration file is provided, Flowtimer will use the following default settings:
-
-- 25 minutes of work
-- 5 minutes of short break
-- 4 work sessions before a 15-minute long break
 
 ### Command-line Options
@@ -125 +127 @@
 
 ```bash
-python flowtimer.py --config myconfig.json
+python3 flowtimer.py --config myconfig.json
 ```