Skip to content

Commit e6ea270

Browse files
committed
fix: book formatting
1 parent e181c4d commit e6ea270

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

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

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ To use OpenVM for generating proofs, you must install the OpenVM command line to
44
either via Git URL or by cloning the repo and building from source manually. Prior to either
55
approach, you should make sure you have installed the necessary [Prerequisites](#installation-prerequisites).
66

7-
## Option 1: Install Via Git URL (Recommended)
7+
Skip [below](#install-with-nvidia-gpu-support) for instructions on installing `cargo-openvm` with Nvidia GPU support.
8+
9+
##
10+
11+
### Option 1: Install Via Git URL (Recommended)
812

913
Begin the installation:
1014

@@ -18,7 +22,7 @@ This will globally install `cargo-openvm`. You can validate a successful install
1822
cargo openvm --version
1923
```
2024

21-
## Option 2: Build from source
25+
### Option 2: Build from source
2226

2327
To build from source, clone the repository and begin the installation.
2428

@@ -34,7 +38,7 @@ This will globally install `cargo-openvm`. You can validate a successful install
3438
cargo openvm --version
3539
```
3640

37-
## Installation Prerequisites
41+
### Installation Prerequisites
3842

3943
Prior to installing `cargo-openvm`, make sure you have the following packages installed:
4044

@@ -59,7 +63,7 @@ cargo install --version 0.5.7 svm-rs
5963
export PATH="$HOME/.cargo/bin:$PATH"
6064

6165
# Install solc 0.8.19
62-
svm install 0.8.19
66+
svm install 0.8.19
6367
```
6468

6569
```bash [macOS]
@@ -85,11 +89,13 @@ svm install 0.8.19
8589
svm use 0.8.19
8690
```
8791

88-
# Install with Nvidia GPU support
92+
:::
93+
94+
## Install with Nvidia GPU support
8995

9096
It is possible to install the OpenVM CLI with support for Nvidia GPUs. This requires installation on a machine with an Nvidia GPU and associated drivers (see [Prerequisites (CUDA)](#installation-prerequisites-cuda))
9197

92-
## Option 1: Install Via Git URL (Recommended)
98+
### Option 1: Install Via Git URL (Recommended)
9399

94100
Begin the installation:
95101

@@ -103,7 +109,7 @@ This will globally install `cargo-openvm`. You can validate a successful install
103109
cargo openvm --version
104110
```
105111

106-
## Option 2: Build from source
112+
### Option 2: Build from source
107113

108114
To build from source, clone the repository and begin the installation.
109115

@@ -119,40 +125,44 @@ This will globally install `cargo-openvm`. You can validate a successful install
119125
cargo openvm --version
120126
```
121127

122-
## Installation Prerequisites (CUDA)
128+
### Installation Prerequisites (CUDA)
123129

124-
You will need all of the [Common Prerequisites](#installation-prerequisites-common). In addition, you will need to have a machine with
130+
You will need all of the [Common Prerequisites](#installation-prerequisites). In addition, you will need to have a machine with
125131
- Nvidia GPU drivers [installed](https://docs.nvidia.com/datacenter/tesla/driver-installation-guide/index.html#)
126132
- CUDA toolkit [installed](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/#)
127133

128134
For machines running Ubuntu 24.04, you can install Nvidia drivers using
135+
129136
```bash [Ubuntu 24.04]
130137
wget https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2404/x86_64/cuda-keyring_1.1-1_all.deb
131138
sudo dpkg -i cuda-keyring_1.1-1_all.deb
132139
sudo apt-get update
133140

134141
sudo apt-get install -y cuda-drivers
135142
```
143+
136144
To check that CUDA drivers are installed, run
137145
```bash
138146
nvidia-smi
139147
```
140148

141149
CUDA toolkit can be installed using the following command, assuming the keyring above has already been installed:
150+
142151
```bash [Ubuntu 24.04]
143152
sudo apt-get install -y cuda-toolkit
144153
export PATH="/usr/local/cuda/bin:$PATH"
145154
```
155+
146156
To check that CUDA toolkit is installed, run
147157
```bash
148158
nvcc --version
149159
```
150160

151161
The OpenVM CLI has been tested with CUDA toolkit version 12.8, and we recommend using CUDA toolkit version 12.8 or higher.
152162

153-
Post-installation, ensure that your shell profile or startup script sets the proper [path variables for CUDA](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/#environment-setup):
163+
Post-installation, ensure that you set the proper [path variables for CUDA](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/#environment-setup):
154164
```bash
155-
LD_LIBRARY_PATH=/usr/local/cuda/lib64${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}
165+
export LD_LIBRARY_PATH=/usr/local/cuda/lib64${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}
156166
```
157167
Note that `/usr/local/cuda` is a symlink for the latest version of CUDA installed.
158168

0 commit comments

Comments
 (0)