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

fix doc

Browse Source
This commit is contained in:
edouardparis 2024-11-14 16:26:33 +01:00
parent f32b6aa30d
commit 6175ca7b58
2 changed files with 10 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -57,14 +57,14 @@ The daemon contains the core logic of the wallet. It is both a library (a Rust c
command interface and a standalone UNIX daemon that exposes a JSONRPC API through a Unix Domain
Socket.
The code for the daemon can be found in the [`src/`](src/) folder at the root of this repository.
The code for the daemon can be found in the [`liana`](liana) folder.
#### Liana GUI
The GUI contains both an installer that guides a user through setting up a Liana wallet, as well as
a graphical interface to the daemon using the [`iced`](https://github.com/iced-rs/iced/) library.
The code for the GUI can be found in the [`gui/src/`](gui/src) folder.
The code for the GUI can be found in the [`liana-gui`](liana-gui) folder.
## Security

26
doc/BUILD.md
View File

@ -68,30 +68,20 @@ Some package managers distribute a version of `rustup`. Failing that, you can al
## Building the project
Once you've got Cargo, building the project is a simple `cargo` invocation away.
To only build the daemon, run it from the root of the repository:
```
$ cargo build --release
```
The `lianad` and `liana-cli` binaries will be in the `target/` directory at the root of the
repository:
```
$ ls target/release/
build deps examples incremental liana-cli liana-cli.d lianad lianad.d libliana.d libliana.rlib
```
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/gui#dependencies) first. Then run
the same command as above within the [`gui/`](../liana-gui/) folder present at the root of the repository:
dependencies](https://github.com/wizardsardine/liana/tree/master/liana-gui#dependencies) first.
Then run:
```
$ cd liana-gui/
$ cargo build --release
```
The `liana-gui` binary will be in the root `target/` folder:
The `lianad`, `liana-cli` and `liana-gui` binaries will be in the `target/` directory at the root of the
repository, except if using Windows in which case only `liana-gui` will be built
(`lianad` and `liana-cli` relies on Unix socket):
```
$ ls target/release/
build deps examples incremental liana-gui liana-gui.d libliana_gui.d libliana_gui.rlib
build deps examples incremental liana-cli liana-cli.d lianad lianad.d liana-gui liana-gui.d libliana.d libliana_gui.d libliana_gui.rlib libliana.rlib libliana_ui.d libliana_ui.rlib
```
Whether your are building the whole wallet or only the daemon, make sure not to forget the