diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..371dd34 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,24 @@ +# About + +`timr-tui` is a TUI to maintain productivity and focus by providing different timers: Pomodoro, Countdown, Timer, Events. + +Built with Rust using `Ratatui` as the main library. + +# Development, Build, Tests + +Check [README](./README.md) chapter `Development` to get all information about how to run, build, test the app. + +# Code Guidelines + +- Idiomatic Rust everywhere +- DRY whenever it makes sense +- Rare or no comments are preferred instead of commenting everything which the code already describes +- Keep tests compact and simple + +# Agent Guidelines + +- Keep your answers compact, but explicit. An user will ask if something is missing. +- For complex tasks provide a plan. +- Structure plans as small as possible. +- Solve complex problems step by step, never all at once. +- Act as a pair programmer, not as a vibe-coding provider. That's an user should guide you, not the opposite. Always ask if something is not clear to you. diff --git a/README.md b/README.md index 06a112c..80c9c5c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # timr-tui -TUI to organize your time: Pomodoro, Countdown, Timer. +TUI to organize your time: Pomodoro, Countdown, Timer, Event. -- `[t]imer` Check the time on anything you are you doing. -- `[c]ountdown` Use it for your workout, yoga session, meditation, handstand or whatever. -- `[p]omodoro` Organize your working time to be focused all the time by following the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). +- `[1] countdown` Use it for your workout, yoga/breathing sessions, meditation, handstand or whatever. +- `[2] timer` Check the time on anything you are you doing. +- `[3] pomodoro` Organize your working time to be focused all the time by following the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). +- `[4] event` Count the time for any event in the future or past. Built with [Ratatui](https://ratatui.rs/) / [Rust 🦀](https://www.rust-lang.org/).