Clean up root readme and add individual libraries' readmes
This commit is contained in:
@@ -2,14 +2,12 @@
|
||||
The Python language bindings for the [bitcoindevkit](https://github.com/bitcoindevkit).
|
||||
|
||||
See the [package on PyPI](https://pypi.org/project/bdkpython/).
|
||||
<br/>
|
||||
|
||||
## Install from PyPI
|
||||
Install the latest release using
|
||||
```shell
|
||||
pip install bdkpython
|
||||
```
|
||||
<br/>
|
||||
|
||||
## Run the tests
|
||||
```shell
|
||||
@@ -19,7 +17,6 @@ python3 setup.py --verbose bdist_wheel
|
||||
pip3 install ./dist/bdkpython-<yourversion>-py3-none-any.whl
|
||||
python -m unittest --verbose tests/test_bdk.py
|
||||
```
|
||||
<br/>
|
||||
|
||||
## Build the package
|
||||
```shell
|
||||
@@ -32,20 +29,18 @@ bash generate.sh
|
||||
# Build the wheel
|
||||
python3 setup.py --verbose bdist_wheel
|
||||
```
|
||||
<br/>
|
||||
|
||||
## Run tox to build and test locally
|
||||
```shell
|
||||
# install dev requirements
|
||||
pip install --requirement requirements-dev.txt
|
||||
|
||||
# build bindings glue code (located at ./src/bdkpython/bdk.py)
|
||||
# build bindings glue code (located at .bdk-python/src/bdkpython/bdk.py)
|
||||
source ./generate.sh
|
||||
|
||||
# build and test
|
||||
tox -vv
|
||||
```
|
||||
<br/>
|
||||
|
||||
## Install locally
|
||||
```shell
|
||||
|
||||
Reference in New Issue
Block a user