-
Notifications
You must be signed in to change notification settings - Fork 4.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update build by source docs to add pre-requisites #34441
Conversation
94add46
to
26c119a
Compare
👋 Following the |
26c119a
to
92b9daf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the additions!
I recommend adding these suggested details about WSL to offer a clear backup for Windows users.
Can you also please run prettier on this file after accepting changes?
From the repo root:
npx --yes prettier --write ./docs/src/cli/install.md
4fd2517
to
9b664ad
Compare
Co-authored-by: Nick Frostbutter <75431177+nickfrosty@users.noreply.github.com>
e72c6ec
to
276dc69
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks again for the updates!
Problem
I was building the Solana binary after following the Setup a Solana Validator guide.
I used a recently created VM for this, so I had a clean environment. I ran
./scripts/cargo-install-all.sh .
up to four times because I didn't have the prerequisites to perform the build. Using a Build from source is encouraged in the guideThe build requirements are pretty standard and are likely to be maintained, but the failures might discourage non-developers from playing around and creating a validator node. This MR tries to fix this by providing extended information on prerequisites before triggering the build.
Summary of Changes
This MR updates the
docs/src/cli/install.md
page from the official documentation, adding the build prerequisites for Linux, macOS, and Windows.