(readme) add keybindings + toc (#78)

* (readme) add keybindings + toc
* update LICENSE
This commit is contained in:
Jens Krause 2025-04-30 14:19:13 +02:00 committed by GitHub
parent 509cf73cdd
commit c96432779a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 73 additions and 3 deletions

View File

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2024 Jens K.
Copyright (c) 2024-2025 Jens Krause
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@ -8,9 +8,20 @@ TUI to organize your time: Pomodoro, Countdown, Timer.
Built with [Ratatui](https://ratatui.rs/) / [Rust 🦀](https://www.rust-lang.org/).
# Features
_Side note:_ Theme colors depend on your terminal preferences.
# Table of Contents
- [Preview](./#preview)
- [CLI](./#cli)
- [Keybindings](./#keybindings)
- [Installation](./#installation)
- [Development](./#development)
- [Misc](./#misc)
- [License](./#license)
# Preview
_(theme depends on your terminal preferences)_
## Pomodoro
@ -89,6 +100,61 @@ Extra option (if `--features sound` is enabled by local build only):
--sound <SOUND> Path to sound file (.mp3 or .wav) to play as notification. Experimental.
```
# Keybindings
## Menu
| Key | Description |
| --- | --- |
| <kbd></kbd> / <kbd></kbd> or <kbd>m</kbd> | Toggle menu |
## Screens
| Key | Description |
| --- | --- |
| <kbd>p</kbd> | Pomodoro |
| <kbd>c</kbd> | Countdown |
| <kbd>t</kbd> | Timer |
## Controls
| Key | Description |
| --- | --- |
| <kbd>s</kbd> | start |
| <kbd>r</kbd> | reset |
| <kbd>e</kbd> | enter edit mode |
| <kbd>q</kbd> | quit |
**In `edit` mode only:**
| Key | Description |
| --- | --- |
| <kbd>Enter</kbd> | apply changes |
| <kbd>Esc</kbd> | skip changes |
| <kbd></kbd> or <kbd></kbd> | change selection |
| <kbd></kbd> or <kbd></kbd> | change values to go up or down |
**In `Pomodoro` screen only**
| Key | Description |
| --- | --- |
| <kbd></kbd> or <kbd></kbd> | switch work/pause |
| <kbd>^r</kbd> | reset round |
**In `Countdown` screen only:**
| Key | Description |
| --- | --- |
| <kbd>^e</kbd> | edit by local time |
## Appearance
| Key | Description |
| --- | --- |
| <kbd>,</kbd> | toggle styles |
| <kbd>.</kbd> | toggle deciseconds |
| <kbd>:</kbd> | toggle local time in footer |
# Installation
## Cargo
@ -224,3 +290,7 @@ C:/Users/{user}/AppData/Local/timr-tui/logs/app.log
```
Optional: You can use a custom directory by passing it via `--log` arg.
# License
[MIT License](./LICENSE)