Skip to content

fix: update inline assembly documentation to reflect stable Rust support #997

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: update inline assembly documentation to reflect stable Rust support #997

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ In addition, the [`curves`](https://github.com/arkworks-rs/algebra/tree/master/c

## Build guide

The library compiles on the `stable` toolchain of the Rust compiler (v 1.51+). To install the latest version of Rust, first install `rustup` by following the instructions [here](https://rustup.rs/), or via your platform's package manager. Once `rustup` is installed, install the Rust toolchain by invoking:
The library compiles on the `stable` toolchain of the Rust compiler (v 1.51+). For the optimized assembly backend, Rust 1.59+ is required. To install the latest version of Rust, first install `rustup` by following the instructions [here](https://rustup.rs/), or via your platform's package manager. Once `rustup` is installed, install the Rust toolchain by invoking:

```bash
rustup install stable
Expand Down Expand Up @@ -71,7 +71,7 @@ To enable this in the `Cargo.toml` of your own projects, enable the `asm` featur
ark-ff = { version = "0.4", features = [ "asm" ] }
```

Note that because inline assembly support in Rust is currently unstable, using this backend requires using the Nightly compiler at the moment.
Note that using this backend requires Rust 1.59+ for stable inline assembly support.

## License

Expand Down
Loading