Skip to content

Commit 199a746

Browse files
committed
Document needing the no_std feature of typenum for no_std builds.
Signed-off-by: Daira-Emma Hopwood <[email protected]>
1 parent 2009e8b commit 199a746

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,14 @@ Requires Rust 1.66+.
99

1010
## `no_std` compatibility
1111

12-
Downstream users of this crate must enable the `spin_no_std` feature of the
13-
`lazy_static` crate in order to take advantage of `no_std` builds; this is due
14-
to the fact that `--no-default-features` builds of `lazy_static` still rely on
15-
`std`.
12+
In order to take advantage of `no_std` builds, downstream users of this crate
13+
must enable:
14+
15+
* the `spin_no_std` feature of the `lazy_static` crate; and
16+
* the `no-std` (note spelling) feature of the `typenum` crate.
17+
18+
This is needed because the `--no-default-features` builds of these crates still
19+
rely on `std`.
1620

1721
## License
1822

0 commit comments

Comments
 (0)