From 3bf780a6df4672f84f2c6d8d7c907519bb4b9590 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 13 Dec 2021 11:20:38 +0100 Subject: [PATCH 1/2] added badges --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index e70c901..eaa6d86 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +[![Crates.io](https://img.shields.io/crates/v/max116xx-10bit)](https://crates.io/crates/max116xx-10bit) +[![build](https://github.com/us-irs/max116xx-10bit-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/us-irs/max116xx-10bit-rs/actions/workflows/ci.yml) +[![docs.rs](https://img.shields.io/docsrs/max116xx-10bit)](https://docs.rs/max116xx-10bit) + Rust Maxim 116xx 10-bit ADC device driver crate ======== From 8b3e43f2178e7508358c3209e55a41e0637346ad Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 13 Dec 2021 11:29:26 +0100 Subject: [PATCH 2/2] release v0.1.1 --- CHANGELOG.md | 4 ++++ Cargo.toml | 2 +- README.md | 3 ++- src/lib.rs | 7 +++++++ 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7011473..f74feb9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [unreleased] +## [v0.1.1] + +- Added badges and some documentation and README tweaks + ## [v0.1.0] - Initial release diff --git a/Cargo.toml b/Cargo.toml index 1154c22..091d581 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "max116xx-10bit" -version = "0.1.0" +version = "0.1.1" authors = ["Robin Mueller "] edition = "2021" description = "Driver crate for the MAX116xx 10-bit ADC devices" diff --git a/README.md b/README.md index eaa6d86..a8452c7 100644 --- a/README.md +++ b/README.md @@ -26,4 +26,5 @@ The crate uses basic type-level support to prevent using the ADC in a wrong way. The type-level support defaults to an externally clocked device with no wake-up delay. This crate was tested using the Vorago REB1 development board. You can find an example application -[here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1). +[here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/src/max11619.rs) +and [here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/examples/max11619-adc.rs). diff --git a/src/lib.rs b/src/lib.rs index 09a07c2..29208db 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,10 @@ +//! The crate uses basic type-level support to prevent using the ADC in a wrong way. +//! The type-level support defaults to an externally clocked device with no wake-up delay. +//! +//! ## Examples +//! +//! You can find an example application [here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/src/max11619.rs) +//! and [here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/examples/max11619-adc.rs) #![no_std] use core::{marker::PhantomData, slice::IterMut}; use embedded_hal::{