Add documentation for easier program initialization
This commit is contained in:
parent
c04f849161
commit
b1c8f8d414
1 changed files with 16 additions and 0 deletions
16
README.md
16
README.md
|
@ -28,6 +28,22 @@ python pomodoroprompt.py
|
|||
|
||||
See the `logs/` folder for daily, one-pomodoro-at-a-time time logs.
|
||||
|
||||
### For more convenient command prompt:
|
||||
|
||||
Create file ``~/.local/bin/pomodoroprompt` with contents:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
|
||||
# Helper to call our pomodoro script. We actually skip the & so we can end it
|
||||
# with ctrl+c
|
||||
|
||||
python ~/Projects/agaric/python/pomodoroprompt/pomodoroprompt.py
|
||||
```
|
||||
|
||||
Now you can start it with `pomodoroprompt` on the command line from any directory.
|
||||
|
||||
|
||||
## Desired improvements
|
||||
|
||||
Too many to write down. Suggest your own:
|
||||
|
|
Loading…
Reference in a new issue