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

Update README

Browse Source
This commit is contained in:
jk 2025-04-17 08:31:40 +02:00
parent 28c5d7194c
commit 675428cfb0
No known key found for this signature in database
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -48,7 +48,7 @@ _Side note:_ Theme colors depend on your terminal preferences.
<img alt="menu" src="demo/menu.gif" /> <img alt="menu" src="demo/menu.gif" />
</a> </a>
## Local time ## Local time (footer)
<a href="demo/local-time.gif"> <a href="demo/local-time.gif">
<img alt="menu" src="demo/local-time.gif" /> <img alt="menu" src="demo/local-time.gif" />
@ -80,15 +80,15 @@ Options:
--blink <BLINK> Toggle blink mode to animate a clock when it reaches its finished mode. [possible values: on, off] --blink <BLINK> Toggle blink mode to animate a clock when it reaches its finished mode. [possible values: on, off]
--log [<LOG>] Directory to store log file. If not set, standard application log directory is used (check README for details). --log [<LOG>] Directory to store log file. If not set, standard application log directory is used (check README for details).
-h, --help Print help -h, --help Print help
-V, --version Print version
``` ```
Extra option (if `--features sound` is enabled by local build only): Extra option (if `--features sound` is enabled by local build only):
```sh ```sh
--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.
``` ```
# Installation # Installation
## Cargo ## Cargo
@ -113,12 +113,10 @@ Install [from the AUR](https://aur.archlinux.org/packages/timr/):
paru -S timr paru -S timr
``` ```
## Release binaries ## Release binaries
Pre-built artifacts are available to download from [latest GitHub release](https://github.com/sectore/timr-tui/releases). Pre-built artifacts are available to download from [latest GitHub release](https://github.com/sectore/timr-tui/releases).
# Development # Development
## Requirements ## Requirements
@ -129,7 +127,6 @@ Pre-built artifacts are available to download from [latest GitHub release](https
If you have [`direnv`](https://direnv.net) installed, run `direnv allow` once to install dependencies. In other case run `nix develop`. If you have [`direnv`](https://direnv.net) installed, run `direnv allow` once to install dependencies. In other case run `nix develop`.
### Non Nix users ### Non Nix users
- [`Rust`](https://www.rust-lang.org/learn/get-started) - [`Rust`](https://www.rust-lang.org/learn/get-started)
@ -162,7 +159,9 @@ Available recipes:
[dev] [dev]
run # run app [alias: r] run # run app [alias: r]
run-args args # run app with arguments. It expects arguments as a string (e.g. "-c 5:00"). [alias: ra]
run-sound path # run app while sound feature is enabled. It expects a path to a sound file. [alias: rs] run-sound path # run app while sound feature is enabled. It expects a path to a sound file. [alias: rs]
run-sound-args path args # run app while sound feature is enabled by adding a path to a sound file and other arguments as string (e.g. "-c 5:00"). [alias: rsa]
[misc] [misc]
format # format files [alias: f] format # format files [alias: f]
@ -175,6 +174,7 @@ Available recipes:
### Build ### Build
- Linux - Linux
```sh ```sh
nix build nix build
# or for bulding w/ statically linked binaries # or for bulding w/ statically linked binaries
@ -182,10 +182,17 @@ nix build .#linuxStatic
``` ```
- Windows (cross-compilation) - Windows (cross-compilation)
```sh ```sh
nix build .#windows nix build .#windows
``` ```
### Run tests
```sh
cargo test
```
# Misc. # Misc.
## Persistant app state ## Persistant app state