Skip to content

Commit

Permalink
List creates in embedded-hal rustdocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Dirbaio committed Sep 13, 2022
1 parent b268c27 commit 13aa203
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions embedded-hal/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,21 @@
//! **NOTE** If you want to use an alpha release of the 1.0.0 version, use an exact version
//! specifier in your `Cargo.toml` like: `embedded-hal = "=1.0.0-alpha.2"`.
//!
//! # Companion crates
//!
//! The main `embedded-hal` crate contains only blocking traits, where the operation is done
//! synchronously before returning. Check out the following crates, which contain versions
//! of the traits for other execution models:
//!
//! - [`embedded-hal-async`](https://docs.rs/embedded-hal-async): async/await-based.
//! - [`embedded-hal-nb`](https://docs.rs/embedded-hal-nb): polling-based, using the `nb` crate.
//!
//! The [`embedded-hal-bus`](https://docs.rs/embedded-hal-bus) crate provides utilities for sharing
//! SPI and I2C buses.
//!
//! Additionally, more domain-specific traits are available in separate crates:
//! - [`embedded-can`](https://docs.rs/embedded-can): Controller Area Network (CAN)
//!
//! # Design goals
//!
//! The HAL
Expand Down

0 comments on commit 13aa203

Please sign in to comment.