From 0a7642213f98bfc1682a8662a2f0027b2cfe919b Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 13 Feb 2025 18:24:57 +0100 Subject: [PATCH] minor doc improvements --- README.md | 2 ++ va416xx-embassy/README.md | 10 ++++++++++ va416xx-embassy/docs.sh | 3 +++ 3 files changed, 15 insertions(+) create mode 100644 va416xx-embassy/README.md create mode 100644 va416xx-embassy/docs.sh diff --git a/README.md b/README.md index aad2a6e..4f88937 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ This workspace contains the following crates: PAC crate containing basic low-level register definition - The [`va416xx-hal`](https://egit.irs.uni-stuttgart.de/rust/va416xx-rs/src/branch/main/va416xx-hal) HAL crate containing higher-level abstractions on top of the PAC register crate. +- The [`va416xx-embassy`](https://egit.irs.uni-stuttgart.de/rust/va416xx-rs/src/branch/main/va108xx-embassy) + crate containing support for running the embassy-rs RTOS. - The [`vorago-peb1`](https://egit.irs.uni-stuttgart.de/rust/va416xx-rs/src/branch/main/vorago-peb1) BSP crate containing support for the PEB1 development board. diff --git a/va416xx-embassy/README.md b/va416xx-embassy/README.md new file mode 100644 index 0000000..813d60e --- /dev/null +++ b/va416xx-embassy/README.md @@ -0,0 +1,10 @@ +[![Crates.io](https://img.shields.io/crates/v/va416xx-embassy)](https://crates.io/crates/va416xx-embassy) +[![docs.rs](https://img.shields.io/docsrs/va416xx-embassy)](https://docs.rs/va416xx-embassy) + +# Embassy-rs support for the Vorago VA416xx MCU family + +This repository contains the [embassy-rs](https://github.com/embassy-rs/embassy) support for the +VA416xx family. Currently, it contains the time driver to allow using embassy-rs. It uses the TIM +peripherals provided by the VA416xx family for this purpose. + +The documentation contains more information on how to use this crate. diff --git a/va416xx-embassy/docs.sh b/va416xx-embassy/docs.sh new file mode 100644 index 0000000..c8ddd4e --- /dev/null +++ b/va416xx-embassy/docs.sh @@ -0,0 +1,3 @@ +#!/bin/bash +export RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" +cargo +nightly doc --open -- 2.43.0