Added installation prerequisites for rustup, uv, just, and MSVC - #49
Open
Hamza1610 wants to merge 1 commit into
Open
Added installation prerequisites for rustup, uv, just, and MSVC#49Hamza1610 wants to merge 1 commit into
Hamza1610 wants to merge 1 commit into
Conversation
thunderbiscuit
left a comment
Member
There was a problem hiding this comment.
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).
| - **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`). |
Member
There was a problem hiding this comment.
This line I'm less clear on: I thought cargo had those for you by default.
Member
There was a problem hiding this comment.
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.|
|
||
| - **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. |
Member
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a
Prerequisitessection to theREADME.mdlisting the core tools required to buildbdkpythonlocally: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
rustupor MSVC build tools needed bycargo build. Adding this helps new contributors quickly verify their local environment before running the build scripts.Changelog notice
Checklists
All Submissions:
New Features: