From 6640b1e703e4bf0b827dde5e01df5b9e74bdca9b Mon Sep 17 00:00:00 2001 From: Robert Hambrock Date: Mon, 4 Nov 2024 13:56:48 +0100 Subject: [PATCH] add readme explainer --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e1177d890..6a02969e90 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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)