about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAshley Mannix <kodraus@hey.com>2021-02-09 12:52:27 +1000
committerGitHub <noreply@github.com>2021-02-09 12:52:27 +1000
commit55f0efcbb4f8e3291ea8cedb97ee94c8db5652bb (patch)
tree19141335474b5b85a955f051029db7a9a6060ed4
parent4ad53da4e02137c9d7e2676a31996fe1aeb22da0 (diff)
downloadrust-55f0efcbb4f8e3291ea8cedb97ee94c8db5652bb.tar.gz
rust-55f0efcbb4f8e3291ea8cedb97ee94c8db5652bb.zip
add a link to docs to the readme
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 049c8b097e7..fe17108c843 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,9 @@
 Code repository for the [Portable SIMD Project Group](https://github.com/rust-lang/project-portable-simd).
 Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) for our contributing guidelines.
 
+The docs for this crate are published from the main branch.
+You can [read them here][docs].
+
 If you have questions about SIMD, we have begun writing a [guide][simd-guide].
 We can also be found on [Zulip][zulip-project-portable-simd].
 
@@ -29,3 +32,4 @@ The `mask` types are "truthy" values, but they use the number of bits in their n
 [simd-guide]: ./beginners-guide.md
 [zulip-project-portable-simd]: https://rust-lang.zulipchat.com/#narrow/stream/257879-project-portable-simd
 [stdarch]: https://github.com/rust-lang/stdarch
+[docs]: https://rust-lang.github.io/stdsimd/core_simd