Skip to content

Commit

Permalink
add readme explainer
Browse files Browse the repository at this point in the history
  • Loading branch information
Lederstrumpf committed Nov 4, 2024
1 parent eaf49be commit 6640b1e
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@ More details of KAGOME development can be found within the [supported features](

#### Prerequisites

If you are using a Debian Linux system, the following command allows you to build KAGOME:
##### Debian/Ubuntu
If you are using a Debian-based Linux system, the following command allows you to build KAGOME:

```sh
git clone https://github.com/qdrvm/kagome
Expand All @@ -121,6 +122,14 @@ make debug_docker
make clear
```

##### Nix(OS)
With the Nix package manager or on NixOS, the project can be instantiated using
1. `nix develop`, or
2. `echo "use flake ." > .envrc && direnv allow`

The build steps are otherwise the same as for Debian-based distros.
Note that with this setup, `.cargo` and `.rustup` will be local to the repository to avoid pollution of the host system.

### Using KAGOME

#### Obtaining database snapshot (optional)
Expand Down

0 comments on commit 6640b1e

Please sign in to comment.