From a0c79735c79ab067f2518ecae1c533e75d194ab0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=20=5Ctimes=203=20=F0=9F=97=BF?= Date: Tue, 19 Nov 2024 10:08:06 +0100 Subject: [PATCH] README: Fix Kani badge and update `no-std` details --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a841d5122..bf66bc65f 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ API Docs Rustc Version 1.63.0+ Chat on IRC - + kani

@@ -49,7 +49,7 @@ are no plans to do so. Of course, patches to fix specific consensus incompatibil ### Support for 16-bit pointer sizes -16-bit pointer sizes are not supported and we can't promise they will be. If you care about them +16-bit pointer sizes are not supported, and we can't promise they will be. If you care about them please let us know, so we can know how large the interest is and possibly decide to support them. ### Semver compliance @@ -103,13 +103,6 @@ current stable one (see MSRV section). ## 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. - The library can be built and tested using [`cargo`](https://github.com/rust-lang/cargo/): ``` @@ -127,6 +120,15 @@ cargo test Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/) for more detailed instructions. +### No-std support + +The `std` cargo feature is enabled by default. To build this project without the Rust standard +library, use the `--no-default-features` flag or set `default-features = false` in your dependency +declaration when adding it to your project. + +For embedded device examples, see [`bitcoin/embedded`](https://github.com/rust-bitcoin/rust-bitcoin/tree/master/bitcoin/embedded) +or [`hashes/embedded`](https://github.com/rust-bitcoin/rust-bitcoin/tree/master/hashes/embedded). + ### Just We support [`just`](https://just.systems/man/en/) for running dev workflow commands. Run `just` from