Skip to content

Commit 290c601

Browse files
authored
feat: add clean install prereqs for Ubuntu and Mac (#1988)
Testing: - Verified on clean Ubuntu install - Verified on clean MacOS install with `xcode-select --install` already run Closes INT-4585
1 parent f6dad57 commit 290c601

File tree

2 files changed

+33
-8
lines changed

2 files changed

+33
-8
lines changed

docs/vocs/docs/pages/book/getting-started/install.mdx

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Install
22

3-
To use OpenVM for generating proofs, you must install the OpenVM command line tool `cargo-openvm`.
4-
5-
`cargo-openvm` can be installed in two different ways. You can either install via git URL or build from source.
3+
To use OpenVM for generating proofs, you must install the OpenVM command line tool `cargo-openvm`
4+
either via Git URL or by cloning the repo and building from source manually. Prior to either
5+
approach, you should make sure you have installed the necessary [Prerequisites](#installation-prerequisites).
66

77
## Option 1: Install Via Git URL (Recommended)
88

99
Begin the installation:
1010

1111
```bash
12-
cargo +1.86 install --locked --git http://github.com/openvm-org/openvm.git --tag v1.4.0-rc.4 cargo-openvm
12+
cargo +1.86 install --locked --git https://github.com/openvm-org/openvm.git --tag v1.4.0-rc.4 cargo-openvm
1313
```
1414

1515
This will globally install `cargo-openvm`. You can validate a successful installation with:
@@ -34,11 +34,36 @@ This will globally install `cargo-openvm`. You can validate a successful install
3434
cargo openvm --version
3535
```
3636

37-
## Install Rust Toolchain
37+
## Installation Prerequisites
3838

39-
In order for the `cargo-openvm` build command to work, you must install certain Rust nightly components:
39+
Prior to installing `cargo-openvm`, make sure you have the following packages installed:
4040

41-
```bash
41+
:::code-group
42+
43+
```bash [Ubuntu]
44+
# install Rust
45+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
46+
. "$HOME/.cargo/env"
47+
48+
# install nightly Rust toolchain for binary builds
4249
rustup install nightly-2025-02-14
4350
rustup component add rust-src --toolchain nightly-2025-02-14
51+
52+
# install build tools for Ubuntu
53+
sudo apt update
54+
sudo apt install -y build-essential # gcc, g++, make, libc headers
4455
```
56+
57+
```bash [macOS]
58+
# install Rust
59+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
60+
. "$HOME/.cargo/env"
61+
62+
# install nightly Rust toolchain for binary builds
63+
rustup install nightly-2025-02-14
64+
rustup component add rust-src --toolchain nightly-2025-02-14
65+
66+
# install build tools for macOS
67+
xcode-select --install
68+
brew install cmake git curl
69+
```

docs/vocs/docs/pages/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { HomePage } from "vocs/components";
1818

1919
```bash [Build with OpenVM]
2020
# install `cargo openvm`
21-
cargo +1.86 install --locked --git http://github.com/openvm-org/openvm.git --tag v1.4.0-rc.4 cargo-openvm
21+
cargo +1.86 install --locked --git https://github.com/openvm-org/openvm.git --tag v1.4.0-rc.4 cargo-openvm
2222

2323
# create a starter OpenVM project
2424
cargo openvm init fibonacci

0 commit comments

Comments
 (0)