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-02-26 11:42:03 +01:00
parent ad11ff2c48
commit c29f8c5d1b
No known key found for this signature in database
1 changed files with 20 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -140,20 +140,26 @@ If you have [`direnv`](https://direnv.net) installed, run `direnv allow` once to
### Commands ### Commands
```sh ```sh
just --list just
Available recipes: Available recipes:
build # build app build # build app [alias: b]
b # alias for `build` default # list commands
default demo-blink # build demo: blink animation [alias: db]
format # format files demo-countdown # build demo: countdown [alias: dc]
f # alias for `format` demo-countdown-met # build demo: countdown + met [alias: dcm]
lint # lint demo-decis # build demo: deciseconds [alias: dd]
l # alias for `lint` demo-local-time # build demo: local time [alias: dlt]
run # run app demo-menu # build demo: menu [alias: dm]
r # alias for `run` demo-pomodoro # build demo: pomodoro [alias: dp]
test # run tests demo-rocket-countdown # build demo: rocket countdown [alias: drc]
t # alias for `test` demo-style # build demo: styles [alias: ds]
demo-timer # build demo: timer [alias: dt]
format # format files [alias: f]
lint # lint [alias: l]
run # run app [alias: r]
run-sound path # run app while sound feature is enabled. It expects a path to a sound file. [alias: rs]
test # run tests [alias: t]
``` ```
### Build ### Build
@ -161,6 +167,8 @@ Available recipes:
- Linux - Linux
```sh ```sh
nix build nix build
# or for bulding w/ statically linked binaries
nix build .#linuxStatic
``` ```
- Windows (cross-compilation) - Windows (cross-compilation)