From a46ca45de0438623421bf7c7a4ee22e085911fb7 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 15 Oct 2020 23:12:32 -0300 Subject: [PATCH] some readme and docs clarification. --- README.md | 10 +++++++--- docs/guide/installation.md | 8 +------- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0f1243b..a5a1a1f 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ LNbits is a very simple Python server that sits on top of any funding source, an * Fallback wallet for the LNURL scheme * Instant wallet for LN demonstrations -The wallet can run on top of any lightning-network funding source, currently there is support for LND, CLightning, Lntxbot, LNpay, OpenNode, with more being added regularily. +The wallet can run on top of any lightning-network funding source, currently there is support for LND, c-lightning, Spark, LNpay, OpenNode, lntxbot, with more being added regularily. See [lnbits.org](https://lnbits.org) for more detailed documentation. @@ -30,9 +30,13 @@ Checkout the LNbits [YouTube](https://www.youtube.com/playlist?list=PLPj3KCksGbS LNbits is inspired by all the great work of [opennode.com](https://www.opennode.com/), and in particular [lnpay.co](https://lnpay.co/). Both work as excellent funding sources for LNbits. -## Running LNbits locally +## Running LNbits -See the [development docs](docs/devs/installation.md) for details on installation and setup. +See the [install guide](docs/guide/installation.md) for details on installation and setup. + +### Contributing to LNbits + +There's a [slightly different setup](docs/devs/installation.md) if you want to contribute to LNbits, but if your changes don't require adding or removing any package dependencies you don't have to bother with that, just follow the [normal installation](docs/guide/installation.md) steps. ## LNbits as an account system diff --git a/docs/guide/installation.md b/docs/guide/installation.md index b61ccf9..4f1bb85 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -27,10 +27,4 @@ Now modify the `.env` file with any settings you prefer and add a proper [fundin Then you can run restart it and it will be using the new settings. -You might also need to install additional packages, depending on the chosen backend. -E.g. when you want to use LND you have to run: - -```sh -./venv/bin/pip install lndgrpc -./venv/bin/pip install purerpc -``` +You might also need to install additional packages or perform additional setup steps, depending on the chosen backend. See [the short guide](./wallets.md) on each different funding source.