Skip to content

Commit

Permalink
Added nix installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
LarsZauberer committed May 17, 2024
1 parent a8bcb97 commit 0a4181d
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,47 @@

A TUI based [alternative](https://thealternative.ch) to [MonkeyType](https://monkeytype.com) written in rust.

## Installation

### Cargo

Simply type

```sh
cargo install crabtype
```

### Nix

To build CrabType for nix just add this derivation to your nix config

```nix
rustapple = pkgs.callPackage (pkgs.fetchFromGitHub {
owner = "einsJannis";
repo = "CrabType";
rev = "<Git Revision>";
sha256 = "<Git SHA>";
}) {};
```

You can figure out the revision and the sha265 by running the application `nix-prefetch-git`

## Run

```sh
crabtype [options...]
```

### Options

```
-g|--gamemode <file>
```

Changes the game mode to the one defined in `<file>`. This file must contain each possible text, separated by newlines.

```
-u|--user <file>
```

Sets the user file to `<file>`, which is the file which stores the stats in a TOML format.

0 comments on commit 0a4181d

Please sign in to comment.