Skip to content

Commit

Permalink
docs: Add no_std section
Browse files Browse the repository at this point in the history
  • Loading branch information
kauppie committed Mar 18, 2024
1 parent 7a45133 commit 286b77f
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,17 @@ You can validate that your CPU supports `bmi2` with the provided example:
$ cargo run --example bmi2_support
```

### `no_std`

`zorder` supports `no_std` targets but `std` feature is enabled by default so you need to disable it:

```toml
[dependencies]
zorder = { version = "<latest>", default-features = false }
```

`std` library is needed for checking BMI2 support.

## Optimization

`zorder` can be around 500 times slower in `dev` mode compared to `release` mode. It is therefore strongly recommended that you enable package level optimizations for `zorder`.
Expand Down

0 comments on commit 286b77f

Please sign in to comment.