From fa904c2c420a1909044ef40b90cdde0913c1051f Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Thu, 5 Jul 2018 13:39:29 -0700 Subject: [PATCH] Add note on backend selection requirement --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f09ba5..4c7353c 100644 --- a/README.md +++ b/README.md @@ -59,8 +59,6 @@ extern crate curve25519_dalek; # 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 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 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]: ```sh