summaryrefslogtreecommitdiffstats
path: root/library/portable-simd/crates/core_simd/examples/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'library/portable-simd/crates/core_simd/examples/README.md')
-rw-r--r--library/portable-simd/crates/core_simd/examples/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/library/portable-simd/crates/core_simd/examples/README.md b/library/portable-simd/crates/core_simd/examples/README.md
new file mode 100644
index 000000000..82747f1b5
--- /dev/null
+++ b/library/portable-simd/crates/core_simd/examples/README.md
@@ -0,0 +1,13 @@
+### `stdsimd` examples
+
+This crate is a port of example uses of `stdsimd`, mostly taken from the `packed_simd` crate.
+
+The examples contain, as in the case of `dot_product.rs`, multiple ways of solving the problem, in order to show idiomatic uses of SIMD and iteration of performance designs.
+
+Run the tests with the command
+
+```
+cargo run --example dot_product
+```
+
+and verify the code for `dot_product.rs` on your machine.