saymrwulf/curve25519-dalek-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/curve25519-dalek-source.git synced 2026-09-06 20:41:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add note on backend selection requirement

Browse source
This commit is contained in:
Henry de Valence 2018-07-05 13:39:29 -07:00
parent 5b009a033e
commit fa904c2c42
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -59,8 +59,6 @@ extern crate curve25519_dalek;
# Backends and Features # Backends and Features
The `std` feature is enabled by default, but it can be disabled.
The `nightly` feature enables features available only when using a Rust nightly The `nightly` feature enables features available only when using a Rust nightly
compiler. **It is recommended for security**. compiler. **It is recommended for security**.
@ -80,6 +78,11 @@ cargo build --no-default-features --features "std avx2_backend"
Crates using `curve25519-dalek` can either select a backend on behalf of their Crates using `curve25519-dalek` can either select a backend on behalf of their
users, or expose feature flags that control the `curve25519-dalek` backend. users, or expose feature flags that control the `curve25519-dalek` backend.
The `std` feature is enabled by default, but it can be disabled for no-`std`
builds using `--no-default-features`. Note that this requires explicitly
selecting an arithmetic backend using one of the `_backend` features.
If no backend is selected, compilation will fail.
Benchmarks are run using [`criterion.rs`][criterion]: Benchmarks are run using [`criterion.rs`][criterion]:
```sh ```sh