sin_serhao/timr-tui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add AGENTS.md (#133)

Browse Source 
* add `AGENTS.md`
* update README
This commit is contained in:
Jens Krause 2025-10-16 12:01:50 +02:00 committed by GitHub
parent c637a82deb
commit dfe3cfcc80
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 29 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
AGENTS.md Normal file
View File

@ -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.

9
README.md
View File

@ -1,10 +1,11 @@
# timr-tui # 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. - `[1] countdown` Use it for your workout, yoga/breathing sessions, meditation, handstand or whatever.
- `[c]ountdown` Use it for your workout, yoga session, meditation, handstand or whatever. - `[2] timer` Check the time on anything you are you doing.
- `[p]omodoro` Organize your working time to be focused all the time by following the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). - `[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/). Built with [Ratatui](https://ratatui.rs/) / [Rust 🦀](https://www.rust-lang.org/).