summaryrefslogtreecommitdiffstats
path: root/library/stdarch/crates/intrinsic-test/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'library/stdarch/crates/intrinsic-test/README.md')
-rw-r--r--library/stdarch/crates/intrinsic-test/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/library/stdarch/crates/intrinsic-test/README.md b/library/stdarch/crates/intrinsic-test/README.md
new file mode 100644
index 000000000..8a8ddab40
--- /dev/null
+++ b/library/stdarch/crates/intrinsic-test/README.md
@@ -0,0 +1,24 @@
+Generate and run programs using equivalent C and Rust intrinsics, checking that
+each produces the same result from random inputs.
+
+# Usage
+```
+USAGE:
+ intrinsic-test [OPTIONS] <INPUT>
+
+FLAGS:
+ -h, --help Prints help information
+ -V, --version Prints version information
+
+OPTIONS:
+ --cppcompiler <CPPCOMPILER> The C++ compiler to use for compiling the c++ code [default: clang++]
+ --runner <RUNNER> Run the C programs under emulation with this command
+ --toolchain <TOOLCHAIN> The rust toolchain to use for building the rust code
+
+ARGS:
+ <INPUT> The input file containing the intrinsics
+```
+
+The intrinsic.csv is the arm neon tracking google sheet (https://docs.google.com/spreadsheets/d/1MqW1g8c7tlhdRWQixgdWvR4uJHNZzCYAf4V0oHjZkwA/edit#gid=0)
+that contains the intrinsic list. The done percentage column should be renamed to "enabled".
+