readme: added nix run
This commit is contained in:
parent
836ad76173
commit
95c7357363
16
README.md
16
README.md
|
@ -4,14 +4,24 @@ dttyper is a terminal-based typing test built with Rust and tui-rs forked from [
|
||||||
|
|
||||||
![Recording](./resources/recording.gif)
|
![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
|
```sh
|
||||||
cargo build
|
cargo build
|
||||||
cargo install --path .
|
cargo install --path .
|
||||||
```
|
```
|
||||||
|
|
||||||
# Develop (using crate2nix)
|
# Develop
|
||||||
|
|
||||||
a. Enter dev shell via nix
|
a. Enter dev shell via nix
|
||||||
|
|
||||||
|
@ -25,7 +35,7 @@ b. modify code and then run with nix
|
||||||
nix run
|
nix run
|
||||||
```
|
```
|
||||||
|
|
||||||
## usage
|
## Usage
|
||||||
|
|
||||||
For usage instructions, you can run `dttyper --help`:
|
For usage instructions, you can run `dttyper --help`:
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue