Skip to content

Commit d5f3c50

Browse files
committed
update README & changelog in preparation of v1.0
the license & contribution part is taken 1:1 from [C-PERMISSIVE]. [C-PERMISSIVE]: https://rust-lang.github.io/api-guidelines/necessities.html#crate-and-its-dependencies-have-a-permissive-license-c-permissive
1 parent 22434c5 commit d5f3c50

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77
<!-- next-header -->
88
## [Unreleased] - ReleaseDate
99
### Added
10+
1011
* Add a `current_standby()` method to check if the driver is currently in standby mode.
1112

1213
### Changed
@@ -15,9 +16,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1516
initialisation to the documented defaults.
1617
* `Motor::new()` and `Driver::new()` methods now also return errors if they fail
1718
to set their outputs upon initialisation.
18-
* Breaking: update to `embedded-hal` 1.0
19-
* Renamed error types to their struct names
20-
* Renamed `DriveCommand::Backwards` to `DriveCommand::Backward` to match
19+
* **Breaking**: update to `embedded-hal` 1.0
20+
* **Breaking**: Renamed error types to their struct names
21+
* **Breaking**: Renamed `DriveCommand::Backwards` to `DriveCommand::Backward` to match
2122
`DriveCommand::Forward`
2223

2324
### Removed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,19 @@ A simple example for the STM32F4 microcontrollers is [available](examples/stm32f
2929
## Changelog
3030
For the changelog please see the dedicated [CHANGELOG.md](CHANGELOG.md).
3131

32-
## Roadmap to v1.0.0
33-
This crate is already stable, however it's based on a release candidate version of [`embedded-hal`](https://github.com/rust-embedded/embedded-hal/),
34-
making the API unstable (the change from 1.0.0-rc.1 to 1.0.0 of e-h will be breaking from a dependency management point of view).
35-
36-
See [the tracking issue](https://github.com/rust-embedded-community/tb6612fng-rs/issues/4) for the roadmap to v1.0.0.
37-
3832
## Minimum Supported Rust Version (MSRV)
39-
This crate is guaranteed to compile on stable Rust 1.62 and up. It *might*
33+
This crate is guaranteed to compile on stable Rust 1.63 and up. It *might*
4034
compile with older versions but that may change in any new patch release.
35+
36+
## License
37+
Licensed under either of
38+
39+
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
40+
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
41+
42+
at your option.
43+
44+
## Contribution
45+
Unless you explicitly state otherwise, any contribution intentionally submitted
46+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
47+
dual licensed as above, without any additional terms or conditions.

0 commit comments

Comments
 (0)