Skip to content

Commit 2f84d32

Browse files
committed
Add README build docs for std and no-std
1 parent d1c71e3 commit 2f84d32

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ coins in a given Bitcoin transaction
3333
More information can be found in [the documentation](https://docs.rs/miniscript)
3434
or in [the `examples/` directory](https://github.com/apoelstra/rust-miniscript/tree/master/examples)
3535

36+
## Building
37+
38+
The cargo feature `std` is enabled by default. At least one of the features `std` or `no-std` or both must be enabled.
39+
40+
Enabling the `no-std` feature does not disable `std`. To disable the `std` feature you must disable default features. The `no-std` feature only enables additional features required for this crate to be usable without `std`. Both can be enabled without conflict.
3641

3742
## Minimum Supported Rust Version (MSRV)
3843
This library should always compile with any combination of features (minus

0 commit comments

Comments
 (0)