better readme
This commit is contained in:
parent
5c71df42fd
commit
292cf471ef
1 changed files with 21 additions and 4 deletions
25
README.md
25
README.md
|
|
@ -1,4 +1,3 @@
|
||||||
# test status
|
|
||||||

|

|
||||||
|
|
||||||
# requirements
|
# requirements
|
||||||
|
|
@ -14,21 +13,39 @@
|
||||||
./tests && echo "PASSED" || echo "FAILED" > /dev/null
|
./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
|
# usage
|
||||||
|
build the lnbits docker image
|
||||||
```console
|
```console
|
||||||
# build the lnbits docker image
|
git clone git@github.com:lnbits/lnbits-legend.git ~/repos/lnbits-legend
|
||||||
cd ~/repos/lnbits-legend
|
cd ~/repos/lnbits-legend
|
||||||
docker build -t 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
|
cd ~/repos/lnbits-legend/docker
|
||||||
source docker-scripts.sh
|
source docker-scripts.sh
|
||||||
|
```
|
||||||
|
start the regtest
|
||||||
|
```console
|
||||||
# start docker-compose with logs
|
# start docker-compose with logs
|
||||||
lnbits-regtest-start-log
|
lnbits-regtest-start-log
|
||||||
# start docker-compose in background
|
# start docker-compose in background
|
||||||
lnbits-regtest-start
|
lnbits-regtest-start
|
||||||
|
```
|
||||||
|
|
||||||
|
usage of the `bitcoin-cli-sim`, `lightning-cli-sim` and `lncli-sim` aliases
|
||||||
|
```console
|
||||||
# use bitcoin core, mine a block
|
# use bitcoin core, mine a block
|
||||||
bitcoin-cli-sim -generate 1
|
bitcoin-cli-sim -generate 1
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue