diff options
| author | Ulf Lilleengen <[email protected]> | 2024-01-12 09:17:26 +0100 |
|---|---|---|
| committer | Ulf Lilleengen <[email protected]> | 2024-01-12 09:17:26 +0100 |
| commit | 7d1257caa055f4ad1b5fa54c9fe28d7f3bc5c5f6 (patch) | |
| tree | 07e4d9972b0b563b08c04ec7a3cbd11c4911781e | |
| parent | 883b923fafc41a23c2ae7a3d26b93992e2726523 (diff) | |
docs: add readme
| -rw-r--r-- | embassy-stm32-wpan/Cargo.toml | 5 | ||||
| -rw-r--r-- | embassy-stm32-wpan/src/lib.rs | 2 |
2 files changed, 7 insertions, 0 deletions
diff --git a/embassy-stm32-wpan/Cargo.toml b/embassy-stm32-wpan/Cargo.toml index ef85ecac8..4f53a400a 100644 --- a/embassy-stm32-wpan/Cargo.toml +++ b/embassy-stm32-wpan/Cargo.toml | |||
| @@ -3,6 +3,11 @@ name = "embassy-stm32-wpan" | |||
| 3 | version = "0.1.0" | 3 | version = "0.1.0" |
| 4 | edition = "2021" | 4 | edition = "2021" |
| 5 | license = "MIT OR Apache-2.0" | 5 | license = "MIT OR Apache-2.0" |
| 6 | description = "Async STM32 WPAN stack for embedded devices in Rust." | ||
| 7 | keywords = ["embedded", "async", "stm32", "ble", "wpan"] | ||
| 8 | categories = ["embedded", "hardware-support", "no-std", "asynchronous"] | ||
| 9 | repository = "https://github.com/embassy-rs/embassy" | ||
| 10 | documentation = "https://docs.embassy.dev/embassy-stm32-wpan" | ||
| 6 | 11 | ||
| 7 | [package.metadata.embassy_docs] | 12 | [package.metadata.embassy_docs] |
| 8 | src_base = "https://github.com/embassy-rs/embassy/blob/embassy-stm32-wpan-v$VERSION/embassy-stm32-wpan/src/" | 13 | src_base = "https://github.com/embassy-rs/embassy/blob/embassy-stm32-wpan-v$VERSION/embassy-stm32-wpan/src/" |
diff --git a/embassy-stm32-wpan/src/lib.rs b/embassy-stm32-wpan/src/lib.rs index a5dbb7420..f9560d235 100644 --- a/embassy-stm32-wpan/src/lib.rs +++ b/embassy-stm32-wpan/src/lib.rs | |||
| @@ -1,5 +1,7 @@ | |||
| 1 | #![no_std] | 1 | #![no_std] |
| 2 | #![allow(async_fn_in_trait)] | 2 | #![allow(async_fn_in_trait)] |
| 3 | #![doc = include_str!("../README.md")] | ||
| 4 | // #![warn(missing_docs)] | ||
| 3 | 5 | ||
| 4 | // This must go FIRST so that all the other modules see its macros. | 6 | // This must go FIRST so that all the other modules see its macros. |
| 5 | mod fmt; | 7 | mod fmt; |
