Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
JssDWt committed Oct 4, 2024
1 parent 4ae6251 commit eeb8676
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,19 @@ In order to install `swapd` you have to compile from source.

### Prerequisites
- [Rust](https://www.rust-lang.org/tools/install) installation
- Core lightning >= **v24.08**.
- `protoc` installation

### Compilation
Run `make release` in the root folder of this repository. The binaries will be
`target/release/swapd` and `target/release/swap-cli`.

## Running
swapd needs cln, bitcoind and postgres to run. See `swapd --help` for
configuration parameters.
In order to run `swapd` the following need to be installed.
- Core lightning >= **v24.08**, accessible over grpc
- bitcoind, accessible with rpc
- postgres

See `swapd --help` for configuration parameters.

## Testing
To run all tests call `make test`, or `PYTEST_PAR=10 make test -j12`.
Expand Down

0 comments on commit eeb8676

Please sign in to comment.