Skip to content
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

[Documentation] Add clearer installation instructions for each architecture #1646

Open
Cardosaum opened this issue Apr 9, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Cardosaum
Copy link
Contributor

Objective

Users should be able to install RISC Zero's toolchain without any doubts around:

  1. If their computer architecture is supported
  2. Which command they should use to install RISC Zero's toolchain
  3. How to check if the installation succeeded

Obstacle

We've noticed users from architectures other than aarch64-apple-darwin and x86_64-unknown-linux-gnu to have doubts on exact steps on how to install the toolchain and whether their computer architecture would be supported at all.

For x86_64-apple-darwin for example, there is a difference between what we mention in cargo-risczero docs and in our docs website - This generates confusion and uncertainty to if it would be possible to run the r0vm in this architecture at all. (This issue is being tracked at #1641 )

Request

We should provide clear and distinct installation instructions for each path of installing RISC Zero's toolchain.
We should have a subsection in our installation docs for:

  • Architectures with prebuilt binaries
  • Architectures that have custom installation instructions - (i.e x86_64-apple-darwin)
  • How to install and update from source to all other architectures
@Cardosaum Cardosaum added the documentation Improvements or additions to documentation label Apr 9, 2024
Copy link

linear bot commented Apr 9, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant