better readme

This commit is contained in:
dni 2022-07-22 11:19:27 +02:00
commit 292cf471ef

View file

@ -1,4 +1,3 @@
# test status
![TESTS](https://github.com/lnbits/legend-regtest-enviroment/actions/workflows/ci.yml/badge.svg)
# requirements
@ -14,21 +13,39 @@
./tests && echo "PASSED" || echo "FAILED" > /dev/null
```
# developement
uncomment following line in docker-compose.yaml, if you wanna use the source code of you current
lnbits-legend repo inside the docker
```yaml
4 volumes:
5 #- ../lnbits:/app/lnbits
```
# usage
build the lnbits docker image
```console
# build the lnbits docker image
git clone git@github.com:lnbits/lnbits-legend.git ~/repos/lnbits-legend
cd ~/repos/lnbits-legend
docker build -t lnbits-legend .
```
# source the scripts
get the regtest enviroment ready
```console
git clone git@github.com:lnbits/legend-regtest-enviroment.git ~/repos/lnbits-legend
mkdir ~/repos/lnbits-legend/docker
cd ~/repos/lnbits-legend/docker
source docker-scripts.sh
```
start the regtest
```console
# start docker-compose with logs
lnbits-regtest-start-log
# start docker-compose in background
lnbits-regtest-start
```
usage of the `bitcoin-cli-sim`, `lightning-cli-sim` and `lncli-sim` aliases
```console
# use bitcoin core, mine a block
bitcoin-cli-sim -generate 1