diff --git a/doc/BUILD.md b/doc/BUILD.md index 290a7d8a..83ad6122 100644 --- a/doc/BUILD.md +++ b/doc/BUILD.md @@ -65,11 +65,18 @@ Some package managers distribute a version of `rustup`. Failing that, you can al "official" [installation method of `rustup`](https://www.rust-lang.org/tools/install) (that is, a `curl`-`sh` pipe). +### With `nix develop` + +If you already have [nix](https://nixos.org)(the package manager), then getting to a development +shell with the necessary build dependencies is as easy as checking out this repository +and then running `nix develop`. + ## Building the project To build the whole wallet including the GUI, you'll need to install its [build and runtime -dependencies](https://github.com/wizardsardine/liana/tree/master/liana-gui#dependencies) first. +dependencies](https://github.com/wizardsardine/liana/tree/master/liana-gui#dependencies) first +(unless you used the `nix develop` step above). Then run: diff --git a/doc/TRY.md b/doc/TRY.md index dc2f43fc..eab96519 100644 --- a/doc/TRY.md +++ b/doc/TRY.md @@ -193,3 +193,12 @@ You can simulate multiple wallets by using different data directories. For insta ./liana-gui --datadir test_charlie ``` The directory will be created if it doesn't exist. + +### Building from source with `nix develop` + +If you have [nix](https://nixos.org) (the package manager) installed, you can easily +build from source as follows: +1. `git clone https://github.com/wizardsardine/liana.git && cd liana` +2. `nix develop` which will put you into a development shell with all dependencies available +3. `cargo build --release` which will build `lianad`, `liana-cli`, and `liana-gui`. +4. `target/release/liana-gui --datadir test_alice` will load up the gui and create/use `./test_alice` as the data directory for liana.