Skip to content

Commit 8e52efb

Browse files
committed
Add MSRV section to readme
1 parent 59eed2a commit 8e52efb

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

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

37+
38+
## Minimum Supported Rust Version (MSRV)
39+
This library should always compile with any combination of features on **Rust 1.29**.
40+
41+
Because some dependencies have broken the build in minor/patch releases, to
42+
compile with 1.29.0 you will need to run the following version-pinning command:
43+
```
44+
cargo update -p cc --precise "1.0.41" --verbose
45+
```
46+
47+
In order to use the `use-serde` feature or to build the unit tests with 1.29.0,
48+
the following version-pinning commands are also needed:
49+
```
50+
cargo update --package "serde" --precise "1.0.98"
51+
cargo update --package "serde_derive" --precise "1.0.98"
52+
```
53+
54+
3755
## Contributing
3856
Contributions are generally welcome. If you intend to make larger changes please
3957
discuss them in an issue before PRing them to avoid duplicate work and

0 commit comments

Comments
 (0)