Skip to content

Commit

Permalink
Bump version to 0.31.0
Browse files Browse the repository at this point in the history
  • Loading branch information
newAM committed Jun 30, 2021
1 parent 3d4cfa3 commit 8ea32bb
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 28 deletions.
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ 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).

## [0.31.0] - 2021-06-30
### Added
- Added compile-time MPSSE command construction macros.

### Changed
- Updated `libftd2xx-ffi` dependency from `0.8.0` to `0.8.3`.

## [0.30.0] - 2021-06-12
### Added
- Added support for `x86_64-apple-darwin`, dynamic linking only.
Expand Down Expand Up @@ -121,7 +128,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Prior releases
A changelog was not kept for prior releases.

[Unreleased]: https://github.com/newAM/libftd2xx-rs/compare/0.30.0...HEAD
[Unreleased]: https://github.com/newAM/libftd2xx-rs/compare/0.31.0...HEAD
[0.31.0]: https://github.com/newAM/libftd2xx-rs/compare/0.30.0...0.31.0
[0.30.0]: https://github.com/newAM/libftd2xx-rs/compare/0.29.0...0.30.0
[0.29.0]: https://github.com/newAM/libftd2xx-rs/compare/0.28.0...0.29.0
[0.28.0]: https://github.com/newAM/libftd2xx-rs/compare/0.27.0...0.28.0
Expand Down
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "libftd2xx"
version = "0.30.0" # remember to update html_root_url
version = "0.31.0" # remember to update html_root_url
authors = ["Alex M. <[email protected]>"]
edition = "2018"
description = "Rust safe wrapper around the libftd2xx-ffi crate."
Expand All @@ -18,7 +18,7 @@ maintenance = { status = "experimental" }
static = ["libftd2xx-ffi/static"]

[dependencies]
libftd2xx-ffi = "~0.8.0"
libftd2xx-ffi = "~0.8.3"
log = "~0.4.11"
paste = "^1"
static_assertions = "^1.1.0"
Expand Down
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,9 @@ Simply add this crate as a dependency in your `Cargo.toml`.

```toml
[dependencies.libftd2xx]
version = "~0.30.0"
version = "~0.31.0"
# statically link the vendor library, defaults to dynamic if not set
# this will make things "just work" on Linux
# not recommended on Windows due to legacy library requirements
# this will make things "just work" on Linux and Windows
features = ["static"]
```

Expand Down Expand Up @@ -65,21 +64,15 @@ Use the `static` feature flag to enable static linking.
The shared object `libftd2xx.so` must exist on your system.
See [FTDI Drivers Installation Guide for Linux] for instructions.

#### Static Linking on Linux

No special considerations are needed, the static library is distributed with
permission from FTDI in the [libftd2xx-ffi] crate.

#### Dynamic Linking on Windows

The FTD2XX DLL must exist on your system PATH.
The easiest way to install this is with the vendor provided [setup executable].

#### Static Linking on Windows
#### Static Linking on Linux or Windows

You must set the "LIBMSVC_PATH" environment variable to link with
`legacy_stdio_definitions.lib` (vendor library requirement).
See [libftd2xx-ffi] for more information.
No special considerations are needed, the static library is distributed with
permission from FTDI in the [libftd2xx-ffi] crate.

## References

Expand Down
19 changes: 6 additions & 13 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@
//!
//! ```toml
//! [dependencies.libftd2xx]
//! version = "~0.30.0"
//! version = "~0.31.0"
//! # statically link the vendor library, defaults to dynamic if not set
//! # this will make things "just work" on Linux
//! # not recommended on Windows due to legacy library requirements
//! # this will make things "just work" on Linux and Windows
//! features = ["static"]
//! ```
//!
Expand Down Expand Up @@ -59,21 +58,15 @@
//! The shared object `libftd2xx.so` must exist on your system.
//! See [FTDI Drivers Installation Guide for Linux] for instructions.
//!
//! ### Static Linking on Linux
//!
//! No special considerations are needed, the static library is distributed with
//! permission from FTDI in the [libftd2xx-ffi] crate.
//!
//! ### Dynamic Linking on Windows
//!
//! The FTD2XX DLL must exist on your system PATH.
//! The easiest way to install this is with the vendor provided [setup executable].
//!
//! ### Static Linking on Windows
//! ### Static Linking on Linux or Windows
//!
//! You must set the "LIBMSVC_PATH" environment variable to link with
//! `legacy_stdio_definitions.lib` (vendor library requirement).
//! See [libftd2xx-ffi] for more information.
//! No special considerations are needed, the static library is distributed with
//! permission from FTDI in the [libftd2xx-ffi] crate.
//!
//! # References
//!
Expand All @@ -99,7 +92,7 @@
//! [`ftd2xx-embedded-hal`]: https://crates.io/crates/ftd2xx-embedded-hal
//! [`embedded-hal`]: https://crates.io/crates/embedded-hal
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc(html_root_url = "https://docs.rs/libftd2xx/0.30.0")]
#![doc(html_root_url = "https://docs.rs/libftd2xx/0.31.0")]
#![deny(missing_docs)]

mod errors;
Expand Down

0 comments on commit 8ea32bb

Please sign in to comment.