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

Merge #179: gui: cleanup the README.

Browse Source 
f1e072bb5f59e0bffb6d39b340bb5be85c132be4 gui: cleanup the README. (Antoine Poinsot)

Pull request description:

  Fixes #105.

ACKs for top commit:
  darosior:
    self-ACK f1e072bb5f59e0bffb6d39b340bb5be85c132be4 -- trivial

Tree-SHA512: a1ef68eacdca0c40ac9ff701b29016ee50cbca15528d8cb028f33532369c109e214ca31be9ec89a9ff59baebd1f3e9d706f9e64303df00462471f64f7f487899
This commit is contained in:
Antoine Poinsot 2022-12-08 15:02:51 +01:00
commit d385e99726
No known key found for this signature in database
GPG Key ID: E13FC145CD3F4304
1 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
gui/README.md
View File

@ -1,37 +1,36 @@
# liana GUI
# Liana GUI
Liana GUI is an user graphical interface written in rust for the
[Liana daemon](https://github.com/revault/liana).
The Liana graphical interface.
## Dependencies
- `fontconfig` (On Debian/Ubuntu `apt install libfontconfig1-dev`)
- [`pkg-config`](https://www.freedesktop.org/wiki/Software/pkg-config/) (On Debian/Ubuntu `apt install pkg-config`)
- Vulkan drivers (On Debian/Ubuntu `apt install mesa-vulkan-drivers libvulkan-dev`)
- `libudev-dev` (On Debian/Ubuntu `apt install libudev-dev`)
You will need a few dependencies in order to run correctly this software. For Linux systems, those
are:
- [`fontconfig`](https://www.freedesktop.org/wiki/Software/fontconfig/) for access to fonts (On Debian/Ubuntu `apt install libfontconfig1-dev`)
- [`libudev-dev`](https://www.freedesktop.org/software/systemd/man/libudev.html) to communicate with devices through USB (On Debian/Ubuntu `apt install libudev-dev`)
In addition, if you want to build the project from source, you will need:
- [`pkg-config`](https://www.freedesktop.org/wiki/Software/pkg-config/) (On Debian/Ubuntu `apt install pkg-config`)
We are striving to remove dependencies, especially the 3D ones.
## Usage
`liana-gui --datadir <datadir> --<network>`
*For a quick guide to try out the software see [../doc/TRY.md](../doc/TRY.md).*
The default `datadir` is the default `lianad` `datadir` (`~/.liana`
for linux) and the default `network` is the bitcoin mainnet.
```
liana-gui --datadir <datadir> --<network>
```
If no argument is provided, the GUI checks in the default `datadir`
the configuration file for the bitcoin mainnet.
The default `datadir` is the same as for `lianad` (`~/.liana` for Linux). The default network is
Bitcoin mainnet, but testnet signet and regtest are supported.
If the provided `datadir` is empty or does not have the configuration
file for the targeted `network`, the GUI starts with the installer mode.
If the software is started with no parameter and no data directory is detected, a Liana installer
will be spawned that will guide you in the processing of configuring Liana.
Instead of using `--datadir` and `--<network>`, a direct path to
the GUI configuration file can be provided with `--conf`.
If the software is started and a reachable `lianad` is running, it will plug to it via `lianad`'s
JSONRPC interface.
After start up, The GUI will connect to the running lianad.
A command starting lianad is launched if no connection is made.
### Troubleshooting
## Troubleshooting
- If you encounter layout issue on `X11`, try to start the GUI with
`WINIT_X11_SCALE_FACTOR` manually set to 1
- If you encounter layout issue on `X11`, try to start the GUI with `WINIT_X11_SCALE_FACTOR`
manually set to 1