Pomodoro: add documentation in the README.md

This commit is contained in:
Jeremy Gardais 2015-10-27 13:27:16 +01:00
parent 70e13a5b0a
commit 12b8e843d2
1 changed files with 26 additions and 0 deletions

View File

@ -17,3 +17,29 @@ Some useful scripts (for me) that can be added to $PATH :)
* zenity_generator: Script to generate zenity window. * zenity_generator: Script to generate zenity window.
* zfSnap.sh: Take snapshot of a ZFS pool. * zfSnap.sh: Take snapshot of a ZFS pool.
### Pomodoro
My implementation of the Pomodoro Technique (https://en.wikipedia.org/wiki/Pomodoro_Technique).
You can simply launch it with:
```sh
pomodoro "Work my french kiss"
```
Then the script will:
* Create a ~/.pomodoro directory to store current task (current.task) and a summary of each week (eg week-42-2015.txt).
* First, it's put task name and a timer (for $WORK_TIME) to the current task file.
* Once the $WORK_TIME has been reached:
1. Log task name and worked time to the weekly log file
2. Toggle the sound to mark a pause
3. It's put a pause/break message for 5/20 minutes as current task
4. Delete the current task file
#### Disavantages
* Must run the script every ~30 minutes
* …?
#### Advantages
* I can display my current task and it's timer wherever i want (tmux, herbstluftwm, …)
* Written to work with /bin/sh