Skip to content

Commit

Permalink
Started a CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
fpagliughi committed Dec 29, 2019
1 parent 3c27d7e commit d52cb14
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion libiio-sys/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = "0.2.0"
authors = ["Frank Pagliughi <[email protected]>"]
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"
Expand Down

0 comments on commit d52cb14

Please sign in to comment.