Skip to content

Commit

Permalink
Add README build docs for std and no-std
Browse files Browse the repository at this point in the history
  • Loading branch information
notmandatory committed Mar 17, 2023
1 parent d1c71e3 commit 2f84d32
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ coins in a given Bitcoin transaction
More information can be found in [the documentation](https://docs.rs/miniscript)
or in [the `examples/` directory](https://github.com/apoelstra/rust-miniscript/tree/master/examples)

## Building

The cargo feature `std` is enabled by default. At least one of the features `std` or `no-std` or both must be enabled.

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.

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

0 comments on commit 2f84d32

Please sign in to comment.