nik/liana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge #1734: minor doc improvements for nix/nixos users

Browse Source 
3dd14224b9201dfbeca5d77f3aeb2e252c7615ca docs: try liana quickly from source for nix/nixos users (VzxPLnHqr)
2de330e7c1047590092a99cccc9bbaa85a54a603 docs: build notes for nix/nixos users (VzxPLnHqr)

Pull request description:

ACKs for top commit:
  edouardparis:
    ACK 3dd14224b9201dfbeca5d77f3aeb2e252c7615ca

Tree-SHA512: 1f5c9d9f318b7facd694616dd1aa15df82ab5499e10424e19c86e69b5fa3028760759c70f0a73eff4aa2afe0eb2c23ebc50288eb845650525e9d1c01ed13f088
This commit is contained in:
edouardparis 2025-06-11 10:29:07 +02:00
commit b4e43dbac2
No known key found for this signature in database
GPG Key ID: E65F7A089C20DC8F
2 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/BUILD.md
View File

@ -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:

9
doc/TRY.md
View File

@ -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.