Skip to content

Added installation prerequisites for rustup, uv, just, and MSVC - #49

Open
Hamza1610 wants to merge 1 commit into
bitcoindevkit:masterfrom
Hamza1610:add-installation-prerequisites
Open

Added installation prerequisites for rustup, uv, just, and MSVC#49
Hamza1610 wants to merge 1 commit into
bitcoindevkit:masterfrom
Hamza1610:add-installation-prerequisites

Conversation

@Hamza1610

Copy link
Copy Markdown

Description

This PR adds a Prerequisites section to the README.md listing the core tools required to build bdkpython locally: rustup, uv, just, and Visual Studio C++ Build Tools for Windows (MSVC target).

Fixes #47

Notes to the reviewers

While setting up the repo on Windows, I noticed the README didn't mention setup dependencies like rustup or MSVC build tools needed by cargo build. Adding this helps new contributors quickly verify their local environment before running the build scripts.

Changelog notice

  • Added installation prerequisites section to README.md

Checklists

All Submissions:

New Features:

  • I've added docs for the new feature

@thunderbiscuit thunderbiscuit left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking a look and running our docs through the Windows lens!

I have two small ideas, but let me know if you think they don't make sense (particularly the 2nd one).

Comment thread README.md
- **Rust toolchain (`rustup`)**: Required to compile `bdk-ffi`. Install from [rustup.rs](https://rustup.rs/).
- **`uv`**: Fast Python package installer and resolver. Install from [Astral uv Docs](https://docs.astral.sh/uv/).
- **`just`**: Command runner used for repo tasks. Install via `cargo install just` or your system package manager.
- **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`).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line I'm less clear on: I thought cargo had those for you by default.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After looking into this, I propose this line instead:

- **`just`**: Command runner used for repo tasks. Install via `cargo install just` or your system package manager.

_Windows Users_
- **Windows**: Rust's `x86_64-pc-windows-msvc` target needs the MSVC toolchain and Windows SDK. `rustup-init` offers to install these for you; otherwise install Visual Studio Build Tools with the *Desktop development with C++* workload. The build scripts are bash, so run them from Git Bash.

Comment thread README.md

- **Rust toolchain (`rustup`)**: Required to compile `bdk-ffi`. Install from [rustup.rs](https://rustup.rs/).
- **`uv`**: Fast Python package installer and resolver. Install from [Astral uv Docs](https://docs.astral.sh/uv/).
- **`just`**: Command runner used for repo tasks. Install via `cargo install just` or your system package manager.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rest of the readme doesn't require just, so I suggest you add it as (optional):

- **`just` (optional)**: Command runner used for repo tasks. Install via `cargo install just` or your system package manager.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add explicit installation prerequisites for rustup, uv, just, and Windows C++ Build Tools

2 participants