mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 06:44:36 +01:00
44 lines
1.2 KiB
Markdown
44 lines
1.2 KiB
Markdown
# DOXA Timer User Manual ⏱️
|
|
|
|
This manual explains how to use the DOXA Timer application.
|
|
|
|
## Getting Started
|
|
|
|
Run the program with:
|
|
```bash
|
|
doxa-timer
|
|
```
|
|
|
|
When you first launch the app, you will see a startup screen. Press `Enter` to access the main interface.
|
|
|
|
## Interface States
|
|
|
|
1. **READY**: The timer is set and waiting for you to start.
|
|
2. **FOCUS**: Work interval. Focus on your tasks.
|
|
3. **SHORT BREAK / LONG BREAK**: Relax. The countdown signals the break duration.
|
|
4. **SETTINGS**: Configuration menu to set durations.
|
|
5. **STATS**: Historical data.
|
|
|
|
## Controls
|
|
|
|
### Main Screen
|
|
- `Space`: Starts or pauses the countdown.
|
|
- `r`: Resets the countdown back to the configured focus or break time.
|
|
- `s`: Opens Settings.
|
|
- `t`: Opens Stats.
|
|
- `l`: Toggles UI translation (English/Czech).
|
|
- `q` / `Esc`: Exits the application.
|
|
|
|
### Settings Screen
|
|
- `up`/`down` or `k`/`j`: Navigate between different settings options:
|
|
- Focus time
|
|
- Short break time
|
|
- Long break time
|
|
- Long break after X pomodoros
|
|
- `+` / `-`: Increase or decrease the value of the active option.
|
|
- `Enter`: Save settings and return to the main screen.
|
|
- `q` / `Esc`: Go back to the main screen without saving changes.
|
|
|
|
### Stats Screen
|
|
- `q` / `Esc`: Return to the main screen.
|