tomodoro 0.2.1

Terminal Pomodoro timer with animated backgrounds
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

# Contributing to tomodoro

## Setup

```sh
git clone https://github.com/linuskelsey/tomodoro
cd tomodoro
cargo build
```

Run locally with:

```sh
cargo run
```

## Linux (Debian / Ubuntu / Mint)

`alsa-sys` requires ALSA development headers:

```sh
sudo apt install libasound2-dev
```

## Project structure

| File | Purpose |
|------|---------|
| `src/main.rs` | Event loop, input handling, app state |
| `src/timer.rs` | Timer state machine and config |
| `src/ui.rs` | All ratatui rendering, edit popup |
| `src/animation.rs` | Themes, render modes, frame ticking |

## Guidelines

- Keep PRs focused — one feature or fix per PR
- Run `cargo clippy` and `cargo fmt` before submitting
- Test in a true-colour terminal (Ghostty, Kitty, WezTerm)

## Reporting issues

Open an issue on [GitHub](https://github.com/linuskelsey/tomodoro/issues).