Skip to content

Commit e640f99

Browse files
docs: add local testing and usage section to readme
1 parent 80dd3e1 commit e640f99

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ src/bdkpython/*.so
6262
build/
6363

6464
testing-setup-py-simple-example.py
65-
localenvironment/
65+
.localpythonenv/

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,19 @@
33
The Python language bindings for the [bitcoindevkit](https://github.com/bitcoindevkit).
44

55
See the [package on PyPI](https://pypi.org/project/bdkpython/).
6+
7+
## Local Testing and Usage
8+
9+
1. Start a Python virtual environment
10+
2. Run one of the build script
11+
3. Create the wheel
12+
4. Install the library
13+
5. Run the tests
14+
15+
```sh
16+
source .localpythonenv/bin/activate
17+
bash scripts/generate-macos-arm64.sh
18+
python3 setup.py bdist_wheel
19+
pip3 install ./dist/bdkpython-<yourversion>.whl --force-reinstall
20+
python3 -m unittest --verbose
21+
```

0 commit comments

Comments
 (0)