Skip to content

Commit 192622b

Browse files
aleasimsnkaskov
authored andcommitted
Add notes about pre-built binaries installation in README
1 parent 278b9dc commit 192622b

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,58 @@ make -C ${ZKLLVM_BUILD:-build} -j$(nproc)
9292

9393
And then use Rust default build system `x.py`.
9494

95+
## Pre-built binaries
96+
97+
### Rust toolchain
98+
99+
You can install `rslang` as another toolchain in `rustup` or as a standalone application.
100+
101+
#### **Supported platforms**
102+
103+
* x86-64 GNU/Linux
104+
105+
#### **Prerequisites**
106+
107+
* Python 3.7+
108+
109+
#### **Installation with `rustup`**
110+
111+
1. Install `rustup` (if needed)
112+
113+
[Official](https://www.rust-lang.org/tools/install) Rust installation:
114+
115+
```bash
116+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
117+
```
118+
119+
If you don't want to install default Rust toolchain (which you actually don't need to use `rslang`), you can pass additional arguments during installation as follows:
120+
121+
```bash
122+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none -y
123+
```
124+
125+
2. Install `rslang`
126+
127+
```bash
128+
curl --proto '=https' --tlsv1.2 -sSfL https://github.com/NilFoundation/zkllvm-rslang/releases/download/v0.0.1-beta/rslang-init.sh | sh
129+
```
130+
131+
This downloads pre-built `rslang` and installes it as a toolchain in your `rustup`.
132+
133+
Now you can use toolchain called `zkllvm` to compile with `rslang`:
134+
135+
```bash
136+
cargo +zkllvm -V
137+
```
138+
139+
#### **Stanalone installation**
140+
141+
You need to pass `PATH` to desired installation directory.
142+
143+
```bash
144+
curl -Ls https://github.com/NilFoundation/zkllvm-rslang/releases/download/v0.0.1-beta/rslang-init.sh | sh -s -- --no-rustup --prefix PATH
145+
```
146+
95147
## Usage
96148

97149
zkLLVM's workflow is as follows:

0 commit comments

Comments
 (0)