You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 2976154
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+43-9Lines changed: 43 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,37 +4,71 @@ The Python language bindings for the [bitcoindevkit](https://github.com/bitcoind
4
4
5
5
See the [package on PyPI](https://pypi.org/project/bdkpython/).
6
6
7
-
# Working with the submodule
7
+
##Working with the submodule
8
8
9
9
This repository uses the bdk-ffi repository as a git submodule. Here are useful tips for working with the submodule:
10
10
11
-
1. When initially cloning the repo, the `bdk-ffi` submodule will be empty locally. You can intitiate/populate the directory by using the `just submodule-init` command.
11
+
1. When initially cloning the repo, the `bdk-ffi` submodule will be empty locally. You can initiate/populate the directory by using the `just submodule-init` command.
12
12
2. If you make local changes to the `bdk-ffi` directory while developing and want to hard delete all changes and return to the exact committed version hash of the bdk-ffi repo, use the `just submodule-reset` command.
13
13
14
14
## Local Testing and Usage
15
15
16
-
1. Run one of the build script (skip the submodule update if you are making local changes to the bdk-ffi submodule)
16
+
1. Run one of the build scripts (skip the submodule update if you are making local changes to the `bdk-ffi` submodule)
17
17
2. Sync dependencies with `uv`
18
18
3. Create the wheel
19
19
4. Install the library
20
20
5. Run the tests
21
21
22
+
### 1. Build Script Commands
23
+
24
+
Run the build script corresponding to your operating system:
25
+
26
+
**Linux**:
27
+
28
+
```sh
29
+
bash scripts/generate-linux.sh
30
+
```
31
+
32
+
**macOS (Apple Silicon / ARM64)**:
33
+
22
34
```sh
23
-
# If you made changes to the bdk-ffi submodule and wish to use those instead of the committed hash
*Note: Pass `--skip-submodule-update` if you are making local changes to `bdk-ffi` and wish to preserve them instead of resetting to the committed submodule hash.*
0 commit comments