50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
# Romodoro
|
|
|
|
|
|
|
|
**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.
|
|
|
|
# Try out (nix)
|
|
|
|
Since nix has cool shells, you can just go ahead and run the following command to try the application out.
|
|
|
|
```bash
|
|
nix run git+https://git.4o1x5.dev/4o1x5/romodoro -- --help
|
|
```
|
|
|
|
# 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]
|
|
-m, --melody-path <PATH> Path to your melody that is played after a session is over (/path/to/melody.mp3)
|
|
-h, --help Print help
|
|
-V, --version Print version
|
|
|
|
```
|
|
|
|
## Features
|
|
|
|
- [x] Adjustable cycle times
|
|
- [ ] Styling
|
|
- [ ] Custom sounds (via .config)
|
|
- [x] Nix flake
|
|
|
|
- [ ] nixosModule
|
|
|
|
- [ ] dbus integration
|
|
- [ ] notification
|
|
- [ ] InfluxDB integration
|
|
|
|
# Develop
|
|
|
|
Enter nix shell
|
|
|
|
```bash
|
|
nix develop
|
|
```
|