From 95c73573636607ff6fdf8cc4070a22670d6192d5 Mon Sep 17 00:00:00 2001 From: 4o1x5 <4o1x5@4o1x5.dev> Date: Fri, 31 May 2024 03:52:45 +0200 Subject: [PATCH] readme: added nix run --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 21d854c..64ca2ca 100644 --- a/README.md +++ b/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) -## 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`: