docs: recommend installing binaries for pcli & pd #3442
Merged
Conversation
This file contains 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
conorsch
force-pushed
the
docs-install-binaries
branch
from
046bdd7 to
41e209b
Compare
conorsch
force-pushed
the
docs-install-binaries
branch
from
41e209b to
544e217
Compare
Updates the guide docs to prefer installing prebuilt binaries, linking out to instructions on compiling from source as an alternative. We also clarify that Windows is not a first-class build target. Closes #3320.
Reimplements the non-cargo, installed-path command invocations for both pcli and pd. This assumes that folks have installed the binaries from the release page. If folks want to compile from source, then they can use `cargo run` or `./target/release/<bin>` themselves. Refs #1976.
conorsch
force-pushed
the
docs-install-binaries
branch
from
544e217 to
8ab04b9
Compare
conorsch
commented
Nov 29, 2023
| extract it, and copy its contents to your `$PATH`. For example: | ||
|
|
||
| ``` | ||
| curl -O -L https://github.com/penumbra-zone/penumbra/releases/download/{{ #include ../penumbra_version.md }}/pd-x86_64-unknown-linux-gnu.tar.xz |
There was a problem hiding this comment.
The #include helper is a dope trick and I'm glad we have it now: there's a single point of update to modify the version number across the whole guide.
conorsch
commented
Nov 29, 2023
| curl -O -L https://github.com/penumbra-zone/penumbra/releases/download/{{ #include ../penumbra_version.md }}/pcli-x86_64-unknown-linux-gnu.tar.xz | ||
| unxz pcli-x86_64-unknown-linux-gnu.tar.xz | ||
| tar -xf pcli-x86_64-unknown-linux-gnu.tar | ||
| sudo mv pcli-x86_64-unknown-linux-gnu/pcli /usr/local/bin/ |
There was a problem hiding this comment.
Nit: should we use a macOS arch for the pcli example? I think saying explicitly: "Make sure choose the correct platform for your machine" is good enough, but open to feedback.
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.
Updates the guide docs to prefer installing prebuilt binaries, linking out to instructions on compiling from source as an alternative. We also clarify that Windows is not a first-class build target.
Closes #3320.