Antoine Poinsot d385e99726
Merge #179: gui: cleanup the README.
f1e072bb5f59e0bffb6d39b340bb5be85c132be4 gui: cleanup the README. (Antoine Poinsot)

Pull request description:

  Fixes #105.

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

Tree-SHA512: a1ef68eacdca0c40ac9ff701b29016ee50cbca15528d8cb028f33532369c109e214ca31be9ec89a9ff59baebd1f3e9d706f9e64303df00462471f64f7f487899
2022-12-08 15:02:53 +01:00
..
2022-11-30 08:51:24 +01:00
2022-12-08 12:21:44 +01:00

Liana GUI

The Liana graphical interface.

Dependencies

You will need a few dependencies in order to run correctly this software. For Linux systems, those are:

  • fontconfig for access to fonts (On Debian/Ubuntu apt install libfontconfig1-dev)
  • libudev-dev 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 (On Debian/Ubuntu apt install pkg-config)

Usage

For a quick guide to try out the software see ../doc/TRY.md.

liana-gui --datadir <datadir> --<network>

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

If the software is started and a reachable lianad is running, it will plug to it via lianad's JSONRPC interface.

Troubleshooting

  • If you encounter layout issue on X11, try to start the GUI with WINIT_X11_SCALE_FACTOR manually set to 1