Skip to content

Commit fc337a7

Browse files
committed
update README
1 parent 6626729 commit fc337a7

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,30 @@
1-
stdsimd
1+
stdsimd - Rust's standard library SIMD components
22
=======
33

44
[![Travis-CI Status]][travis] [![Appveyor Status]][appveyor] [![Latest Version]][crates.io] [![docs]][docs.rs]
55

6-
> Experimental support for SIMD destined to eventually become part of Rust's
7-
> standard library
6+
# Usage
87

9-
This is a **work in progress**.
8+
`stdsimd` is now shipped with Rust's `std` library - its is part of `libcore`
9+
and `libstd`.
10+
11+
The easiest way to use it is just to import it via `use std::arch`.
12+
13+
The `std::arch` component for `x86` is available in stable Rust. The `std::arch`
14+
components for other architectures and the `std::simd` component require nightly
15+
Rust.
16+
17+
Using `stdsimd` master branch is not recommended. It requires nightly Rust, it
18+
only works with particular Rust nightly versions, and it can (and does) break
19+
often. If you need to use `stdsimd` master branch, you can add it to your
20+
`Cargo.toml` as follows:
21+
22+
```toml
23+
#[dependencies]
24+
stdsimd = { git = "https://github.com/rust-lang-nursery/stdsimd.git" }
25+
```
26+
27+
# Documentation
1028

1129
* [Documentation - i686][i686]
1230
* [Documentation - x86\_64][x86_64]

0 commit comments

Comments
 (0)