From 60ebc0d907b0095c756d0b49977307890aa6ea4e Mon Sep 17 00:00:00 2001 From: jon-chuang <9093549+jon-chuang@users.noreply.github.com> Date: Wed, 22 Apr 2020 17:05:48 +0800 Subject: [PATCH] readme asm instructions --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6e6032d..142ca76 100644 --- a/README.md +++ b/README.md @@ -64,9 +64,9 @@ cargo build --release This library comes with unit tests for each of the provided crates. Run the tests with: ```bash cargo test -``` +``` -Lastly, this library comes with benchmarks for the following crates: +This library comes with benchmarks for the following crates: - [`algebra`](algebra) - [`dpc`](dpc) @@ -76,6 +76,16 @@ These benchmarks require the nightly Rust toolchain; to install this, run `rustu cargo +nightly bench ``` +To make use of `adcxq`, `adoxq` and `mulxq` available on most modern `x86_64` platforms (at least starting from Haswell): +```bash +RUSTFLAGS="--emit=asm -C target-feature=+bmi2,+adx" cargo +nightly test/build/bench --features asm +``` + +To run with multiple features, make sure to double quote the features. E.g. +```bash +RUSTFLAGS="--emit=asm -C target-feature=+bmi2,+adx" cargo +nightly test --features "asm bls12_381" +``` + ## License ZEXE is licensed under either of the following licenses, at your discretion.