Skip to content

Commit d8c6d4e

Browse files
committed
Added installation prerequisites for rustup, uv, just, and MSVC
1 parent 79c16e9 commit d8c6d4e

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ This repository uses the bdk-ffi repository as a git submodule. Here are useful
1111
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.
1212
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.
1313

14+
## Prerequisites
15+
16+
Before building `bdkpython` locally, ensure you have installed the following tools:
17+
18+
- **Rust toolchain (`rustup`)**: Required to compile `bdk-ffi`. Install from [rustup.rs](https://rustup.rs/).
19+
- **`uv`**: Fast Python package installer and resolver. Install from [Astral uv Docs](https://docs.astral.sh/uv/).
20+
- **`just`**: Command runner used for repo tasks. Install via `cargo install just` or your system package manager.
21+
- **Windows (C++ Build Tools)**: Install Visual Studio Build Tools with the *Desktop development with C++* workload (provides `link.exe` and MSVC toolchain required for `x86_64-pc-windows-msvc`).
22+
1423
## Local Testing and Usage
1524

1625
1. Run one of the build script (skip the submodule update if you are making local changes to the bdk-ffi submodule)

0 commit comments

Comments
 (0)