explain how to run the verification tests

rust-lang · Aug 12, 2018 · e469b4a · e469b4a
1 parent 5394128
commit e469b4a
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/verify/readme.md b/verify/readme.md
@@ -1,5 +1,22 @@
 # Machine code verification
 
+## Quick start
+
+To run the verification tests run:
+
+```
+cargo test --release
+```
+
+on this crate, eventually passing the required target features via `RUSTFLAGS`.
+For example, `RUSTFLAGS="-C target-feature=+avx2"`.
+
+This crate only contains tests, and the tests only run in `--release` mode.
+Therefore, building this crate with anything different from `cargo test
+--release` does not make much sense.
+
+## How it works
+
 This crates verifies the machine code generated for some of the portable packed
 vector APIs by disassembling the API at run-time and comparing the machine code
 generated against the desired one for a particular target and target features.