romodoro/README.md

37 lines
866 B
Markdown
Raw Normal View History

2024-05-21 19:51:46 +02:00
# Romodoro
A faulty pomodoro program
![Romodoro](.assets/romodoro.gif)
**Romodoro is a basic TUI application that keeps track of your time with the help of the pomodoro technique.** It follows the original technique by deviding workloads into a set of 4x4 Work and Pause cycles which are then finished off with a long break.
# Usage
```
Usage: romodoro [OPTIONS]
Options:
-w, --work <WORK> Working length in minutes [default: 25]
-p, --pause <PAUSE> The length of a pause [default: 5]
-l, --long-pause <LONG_PAUSE> The length of a long pause (after 4 cycles) [default: 20]
-h, --help Print help
-V, --version Print version
```
## Features
- [x] Adjustable cycle times
- [ ] Styling
- [ ] Custom sounds (via .config)
- [x] Nix flake
# Develop
Enter nix shell
```bash
nix develop
```