Prepare publish (#39)
* refactor!: rename `.data` and `.log` files - `timr.data` -> `app.data` - `timr.log` -> `app.log` * refactor!: rename app name `timr` -> `timr-tui` * docs: update README (paths, names, installation) * update Cargo.toml * fix(release): warning: unused variable: `log_dir`
This commit is contained in:
66
README.md
66
README.md
@@ -1,8 +1,6 @@
|
||||
# tim:r
|
||||
# timr-tui
|
||||
|
||||
**Pronounced `/ˈtʌɪmə/` or `/ˈtaɪmər/`.**
|
||||
|
||||
`tim:r` is a TUI app to help organize one of the most important thing you might have in live: `time`!
|
||||
TUI to organize your time: Pomodoro, Countdown, Timer.
|
||||
|
||||
- `[t]imer` Check the time on anything you are you doing.
|
||||
- `[c]ountdown` Use it for your workout, yoga session, meditation, handstand or whatever.
|
||||
@@ -50,10 +48,12 @@ _Side note:_ Theme colors depend on your terminal preferences.
|
||||
<img alt="menu" src="demo/menu.gif" />
|
||||
</a>
|
||||
|
||||
# Args ⚙️
|
||||
# CLI
|
||||
|
||||
```sh
|
||||
Usage: timr [OPTIONS]
|
||||
timr-tui --help
|
||||
|
||||
Usage: timr-tui [OPTIONS]
|
||||
|
||||
Options:
|
||||
-c, --countdown <COUNTDOWN> Countdown time to start from. Formats: 'ss', 'mm:ss', or 'hh:mm:ss' [default: 10:00]
|
||||
@@ -68,6 +68,20 @@ Options:
|
||||
-V, --version Print version
|
||||
```
|
||||
|
||||
# Installation
|
||||
|
||||
From [crates.io](https://crates.io/crates/timr-tui) run:
|
||||
|
||||
```sh
|
||||
cargo install timr-tui
|
||||
```
|
||||
|
||||
Latest version from git repository:
|
||||
|
||||
```sh
|
||||
cargo install --git https://github.com/sectore/timr-tui
|
||||
```
|
||||
|
||||
# Build from source 🔧
|
||||
|
||||
## Requirements
|
||||
@@ -121,38 +135,26 @@ nix build .#windows
|
||||
|
||||
## Persistant app state
|
||||
|
||||
Stored on file system.
|
||||
Stored on file system:
|
||||
|
||||
- `Linux`
|
||||
```sh
|
||||
cat ~/.local/state/timr/data/timr.data
|
||||
```
|
||||
|
||||
- `macOS`
|
||||
```sh
|
||||
cat /Users/{user}/Library/Application Support/timr/data/timr.data
|
||||
```
|
||||
|
||||
- `Windows`
|
||||
```sh
|
||||
cat C:/Users/{user}/AppData/Local/timr/data/timr.data
|
||||
# Linux
|
||||
~/.local/state/timr-tui/data/app.data
|
||||
# macOS
|
||||
/Users/{user}/Library/Application Support/timr-tui/data/app.data
|
||||
# Windows
|
||||
C:/Users/{user}/AppData/Local/timr-tui/data/app.data
|
||||
```
|
||||
|
||||
## Logs
|
||||
|
||||
In `debug` mode only.
|
||||
In `debug` mode only. Locations:
|
||||
|
||||
- `Linux`
|
||||
```sh
|
||||
tail -f ~/.local/state/timr/logs/timr.log
|
||||
```
|
||||
|
||||
- `macOS`
|
||||
```sh
|
||||
tail -f /Users/{user}/Library/Application Support/timr/logs/timr.log
|
||||
```
|
||||
|
||||
- `Windows`
|
||||
```sh
|
||||
tail -f C:/Users/{user}/AppData/Local/timr/logs/timr.log
|
||||
# Linux
|
||||
~/.local/state/timr/logs/app.log
|
||||
# macOS
|
||||
/Users/{user}/Library/Application Support/timr-tui/logs/app.log
|
||||
# `Windows`
|
||||
C:/Users/{user}/AppData/Local/timr-tui/logs/app.log
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user