romodoro/README.md

42 lines
1 KiB
Markdown
Raw Normal View History

2024-05-21 19:51:46 +02:00
# Romodoro
![Romodoro](.assets/romodoro.gif)
2024-05-22 00:35:46 +02:00
**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 dividing workloads into a set of 4x4 Work and Pause cycles which are then finished off with a long break.
2024-05-21 19:51:46 +02:00
# 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]
2024-05-22 00:35:46 +02:00
-m, --melody-path <PATH> Path to your melody that is played after a session is over (/path/to/melody.mp3)
2024-05-21 19:51:46 +02:00
-h, --help Print help
-V, --version Print version
```
## Features
- [x] Adjustable cycle times
- [ ] Styling
- [ ] Custom sounds (via .config)
- [x] Nix flake
2024-05-22 00:37:02 +02:00
- [ ] nixosModule
- [ ] dbus integration
- [ ] notification
- [ ] InfluxDB integration
2024-05-21 19:51:46 +02:00
# Develop
Enter nix shell
```bash
nix develop
```