(readme) add keybindings + toc (#78)
* (readme) add keybindings + toc * update LICENSE
This commit is contained in:
parent
509cf73cdd
commit
c96432779a
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
|||||||
MIT License
|
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
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
74
README.md
74
README.md
@ -8,9 +8,20 @@ TUI to organize your time: Pomodoro, Countdown, Timer.
|
|||||||
|
|
||||||
Built with [Ratatui](https://ratatui.rs/) / [Rust 🦀](https://www.rust-lang.org/).
|
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
|
## 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.
|
--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
|
# Installation
|
||||||
|
|
||||||
## Cargo
|
## 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.
|
Optional: You can use a custom directory by passing it via `--log` arg.
|
||||||
|
|
||||||
|
# License
|
||||||
|
|
||||||
|
[MIT License](./LICENSE)
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user