From 107189b166b1b90822d499e7623c761f0ed3c715 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 13 Feb 2025 15:12:14 +0100 Subject: [PATCH] prepare va108xx-embassy release --- examples/rtic/Cargo.toml | 2 +- examples/simple/Cargo.toml | 2 +- va108xx-embassy/CHANGELOG.md | 9 +++++++++ va108xx-embassy/Cargo.toml | 14 ++++++++++++-- va108xx-embassy/src/lib.rs | 3 ++- 5 files changed, 25 insertions(+), 5 deletions(-) create mode 100644 va108xx-embassy/CHANGELOG.md diff --git a/examples/rtic/Cargo.toml b/examples/rtic/Cargo.toml index 1a4fc06..9070a3b 100644 --- a/examples/rtic/Cargo.toml +++ b/examples/rtic/Cargo.toml @@ -23,4 +23,4 @@ once_cell = {version = "1", default-features = false, features = ["critical-sect ringbuf = { version = "0.4.7", default-features = false, features = ["portable-atomic"] } va108xx-hal = "0.9" -vorago-reb1 = { path = "../../vorago-reb1" } +vorago-reb1 = "0.7" diff --git a/examples/simple/Cargo.toml b/examples/simple/Cargo.toml index 4437dd3..05fc339 100644 --- a/examples/simple/Cargo.toml +++ b/examples/simple/Cargo.toml @@ -20,4 +20,4 @@ version = "0.9" features = ["rt", "defmt"] [dependencies.vorago-reb1] -path = "../../vorago-reb1" +version = "0.7" diff --git a/va108xx-embassy/CHANGELOG.md b/va108xx-embassy/CHANGELOG.md new file mode 100644 index 0000000..d2018c5 --- /dev/null +++ b/va108xx-embassy/CHANGELOG.md @@ -0,0 +1,9 @@ +Change Log +======= + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) +and this project adheres to [Semantic Versioning](http://semver.org/). + +## [unreleased] diff --git a/va108xx-embassy/Cargo.toml b/va108xx-embassy/Cargo.toml index 68a7dcb..01cc390 100644 --- a/va108xx-embassy/Cargo.toml +++ b/va108xx-embassy/Cargo.toml @@ -2,6 +2,13 @@ name = "va108xx-embassy" version = "0.1.0" edition = "2021" +authors = ["Robin Mueller "] +description = "Embassy-rs support for the Vorago VA108xx family of microcontrollers" +homepage = "https://egit.irs.uni-stuttgart.de/rust/va108xx-rs" +repository = "https://egit.irs.uni-stuttgart.de/rust/va108xx-rs" +license = "Apache-2.0" +keywords = ["no-std", "hal", "cortex-m", "vorago", "va108xx"] +categories = ["aerospace", "embedded", "no-std", "hardware-support"] [dependencies] critical-section = "1" @@ -14,8 +21,7 @@ embassy-time-queue-utils = "0.1" once_cell = { version = "1", default-features = false, features = ["critical-section"] } -[dependencies.va108xx-hal] -path = "../va108xx-hal" +va108xx-hal = "0.9" [features] default = ["irq-oc30-oc31"] @@ -25,3 +31,7 @@ irqs-in-lib = [] irq-oc28-oc29 = ["irqs-in-lib"] irq-oc29-oc30 = ["irqs-in-lib"] irq-oc30-oc31 = ["irqs-in-lib"] + +[package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--generate-link-to-definition"] diff --git a/va108xx-embassy/src/lib.rs b/va108xx-embassy/src/lib.rs index 6816f00..7618dd4 100644 --- a/va108xx-embassy/src/lib.rs +++ b/va108xx-embassy/src/lib.rs @@ -29,8 +29,9 @@ //! //! ## Examples //! -//! [embassy example project](https://egit.irs.uni-stuttgart.de/rust/va108xx-rs/src/branch/main/examples/embassy) +//! [embassy example projects](https://egit.irs.uni-stuttgart.de/rust/va108xx-rs/src/branch/main/examples/embassy) #![no_std] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] use core::cell::{Cell, RefCell}; use critical_section::CriticalSection; use embassy_sync::blocking_mutex::CriticalSectionMutex as Mutex; -- 2.43.0