4o1x5/dttyper
4o1x5/dttyper
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

readme: added nix run

Browse source
This commit is contained in:
Barna Máté 2024-05-31 03:52:45 +02:00
parent 836ad76173
commit 95c7357363
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -4,14 +4,24 @@ dttyper is a terminal-based typing test built with Rust and tui-rs forked from [
![Recording](./resources/recording.gif)
## installation
# Try out (nix)
Since nix has cool shells, you can just go ahead and run the following command to try the application out.
```bash
nix run git+https://git.4o1x5.dev/4o1x5/dttyper -- --help
```
## Installation
This should work on any distro out there.
```sh
cargo build
cargo install --path .
```
# Develop (using crate2nix)
# Develop
a. Enter dev shell via nix
@ -25,7 +35,7 @@ b. modify code and then run with nix
nix run
```
## usage
## Usage
For usage instructions, you can run `dttyper --help`: