Skip to content

Commit c5a1df0

Browse files
committed
README fixes.
1 parent c090f4d commit c5a1df0

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

embedded-hal/README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,6 @@
99
1010
This project is developed and maintained by the [HAL team](https://github.com/rust-embedded/wg#the-hal-team).
1111

12-
**NOTE** This HAL is still in active development. Expect the traits presented here to be
13-
tweaked, split or be replaced wholesale before being stabilized, i.e. before hitting the 1.0.0
14-
release.
15-
16-
**NOTE** If you want to use an alpha release of the 1.0.0 version, use an exact version
17-
specifier in your `Cargo.toml` like: `embedded-hal = "=1.0.0-alpha.2"`.
18-
1912
## Companion crates
2013

2114
The main `embedded-hal` crate contains only blocking traits, where the operation is done
@@ -30,6 +23,14 @@ SPI and I2C buses.
3023

3124
Additionally, more domain-specific traits are available in separate crates:
3225
- [`embedded-can`](https://docs.rs/embedded-can): Controller Area Network (CAN)
26+
- [`embedded-io`](https://docs.rs/embedded-io): I/O byte streams (like `std::io`, but `no-std`-compatible).
27+
28+
## Serial/UART traits
29+
30+
There is no serial traits in `embedded-hal`. Instead, use [`embedded-io`](https://crates.io/crates/embedded-io).
31+
A serial port is essentially a byte-oriented stream, and that's what `embedded-io` models. Sharing the traits
32+
with all byte streams has some advantages. For example, it allows generic code providing a command-line interface
33+
or a console to operate either on hardware serial ports or on virtual ones like Telnet or USB CDC-ACM.
3334

3435
## Design goals
3536

@@ -77,13 +78,6 @@ If you are writing a platform-agnostic driver yourself you are highly encouraged
7778
embedded-hal keyword](https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata)
7879
to your crate before publishing it!
7980

80-
## Serial/UART traits
81-
82-
There is no serial traits in `embedded-hal`. Instead, use [`embedded-io`](https://crates.io/crates/embedded-io).
83-
A serial port is essentially a byte-oriented stream, and that's what `embedded-io` models. Sharing the traits
84-
with all byte streams has some advantages. For example, it allows generic code providing a command-line interface
85-
or a console to operate either on hardware serial ports or on virtual ones like Telnet or USB CDC-ACM.
86-
8781
## Optional Cargo features
8882

8983
- **`defmt-03`**: Derive `defmt::Format` from `defmt` 0.3 for enums and structs.

0 commit comments

Comments
 (0)