prepare release for BSP

us-irs · Oct 1, 2024 · ff58fb7 · ff58fb7
1 parent b1f63b6
commit ff58fb7
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 9 deletions.
diff --git a/vorago-peb1/README.md b/vorago-peb1/README.md
@@ -1,15 +1,12 @@
-# Rust BSP for the Vorago PEB1 development board
-
-## Using the `.cargo/config.toml` file
+[![Crates.io](https://img.shields.io/crates/v/vorago-peb1)](https://crates.io/crates/vorago-peb1)
+[![docs.rs](https://img.shields.io/docsrs/vorago-peb1)](https://docs.rs/vorago-peb1)
 
-Use the following command to have a starting `config.toml` file
+# Rust BSP for the Vorago PEB1 development board
 
-```sh
-cp .cargo/def-config.toml .cargo/config.toml
-```
+This is the Rust **B**oard **S**upport **P**ackage crate for the Vorago PEB1 development board.
+Its aim is to provide drivers for the board features of the PEB1 board.
 
-You then can adapt the `config.toml` to your needs. For example, you can configure runners
-to conveniently flash with `cargo run`.
+The BSP builds on top of the [HAL crate for VA416xx devices](https://egit.irs.uni-stuttgart.de/rust/va416xx-rs/src/branch/main/va416xx-hal).
 
 ## Notes on board revisions
 

diff --git a/vorago-peb1/src/lib.rs b/vorago-peb1/src/lib.rs
@@ -5,6 +5,10 @@
 pub use lis2dh12;
 
 /// Support for the LIS2DH12 accelerometer on the GPIO board.
+///
+/// # Example
+///
+/// - [PEB1 Accelerometer](https://egit.irs.uni-stuttgart.de/rust/va416xx-rs/src/branch/main/examples/simple/examples/peb1-accelerometer.rs)
 pub mod accelerometer {
 
     use lis2dh12::{self, detect_i2c_addr, AddrDetectionError, Lis2dh12};