From d52cb143ba64a180231f58fea58fd5b3731e491d Mon Sep 17 00:00:00 2001 From: fpagliughi Date: Sun, 29 Dec 2019 09:07:28 -0500 Subject: [PATCH] Started a CHANGELOG --- CHANGELOG.md | 20 ++++++++++++++++++++ README.md | 6 +++++- libiio-sys/Cargo.toml | 2 +- 3 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8e5fce7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,20 @@ +# Change Log +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [v0.2](https://github.com/fpagliughi/rust-industrial-io/compare/v0.1..v0.2) - 2019-12-29 + +- Support for libiio v0.18 +- Further implementation of _libiio_ functions for contexts, devices, channels, etc. +- Functions to read and write buffers, with and without conversions, and to convert individual samples to and from hardware format. +- [Breaking] Removed previous `ChannelType` for Input/Output as it conflicted with the library's channel types of `Voltage`, `Current`, `Power`, etc, and implemented the library type. +- Contexts have a ref-counted "inner" representation using _Rc<>_, and can be "cloned" quickly by incrementing the count. (Thanks, @skrap!) + - Devices carry a cloned reference to the context that created them, thus keeping the context alive until the last device using it gets dropped. + - Some clippy-recommended lints. + - Example app to collect and process data a buffer at a time, with conversions. + +## v0.1 - 2018-11-21 + +- Initial version +- Basic functionality for contexts, devices, channels, and buffers. \ No newline at end of file diff --git a/README.md b/README.md index ac498c3..1d8d45c 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,10 @@ An effort is underway to get this crate to production quality. This will hopeful - A complete set of working examples. - Unit tests and CI +To keep up with the latest announcements for this project, follow: + +**Twitter:** [@fmpagliughi](https://twitter.com/fmpagliughi) + ### New in v0.2 - Support for libiio v0.18 @@ -30,7 +34,7 @@ An effort is underway to get this crate to production quality. This will hopeful - Contexts have a ref-counted "inner" representation using _Rc<>_, and can be "cloned" quickly by incrementing the count. (Thanks, @skrap!) - Devices carry a cloned reference to the context that created them, thus keeping the context alive until the last device using it gets dropped. - Some clippy-recommended lints. - - Sample to collect and process data a buffer at a time. + - Example app to collect and process data a buffer at a time, with conversions. ## Testing the Crate diff --git a/libiio-sys/Cargo.toml b/libiio-sys/Cargo.toml index ad29186..2c82640 100644 --- a/libiio-sys/Cargo.toml +++ b/libiio-sys/Cargo.toml @@ -4,7 +4,7 @@ version = "0.2.0" authors = ["Frank Pagliughi "] repository = "https://github.com/fpagliughi/rust-industrial-io" homepage = "https://github.com/fpagliughi/rust-industrial-io" -description = "Native, unsafe, bindings to the Linux libiio library" +description = "Native, unsafe, bindings to the Linux libiio library. Used by industrial-io." license = "MIT" links = "iio" build = "build.rs"