Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
bigspider committed May 1, 2024
1 parent 3e2d065 commit bd4d948
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ Install the library with:
$ pip install .
```

If you're also modifying the framework, you might want to install the package in editable mode:

```bash
$ pip install -e .
```

## Run bitcoin-inquisition MATT in regtest mode

The fastest way to get started is [this docker container](https://github.com/Merkleize/docker):
Expand Down Expand Up @@ -66,10 +72,10 @@ For the ones marked with [cli], a simple interactive tool allows to play with th

# Tests

This project uses `pytest` to run automated tests. Install it with:
This project uses `pytest` to run automated tests. Install the dependencies with:

```bash
$ pip install pytest
$ pip install -r requirements-dev.txt
```

The test suite requires a running instance of the MATT-enabled bitcoin-inquisition, for example using the container above. The [init.sh](examples/init.sh) script makes sure that a funded test wallet is loaded.
Expand Down

0 comments on commit bd4d948

Please sign in to comment.