Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update changelog (content+format). Update MSRV text. #358

Merged
merged 1 commit into from
Aug 2, 2024
+55 −11
Merged

Update changelog (content+format). Update MSRV text. #358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 34 additions & 8 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,53 @@
# Changelog

<!-- Instructions

This changelog follows the patterns described here: <https://keepachangelog.com/en/1.0.0/>.
This changelog follows the patterns described here: <https://keepachangelog.com/en/>.

Subheadings to categorize changes are `added, changed, deprecated, removed, fixed, security`.

-->

# Changelog

The latest published Kurbo release is [0.11.0](#0110-2024-02-14) which was released on 2024-02-14.
You can find its changes [documented below](#0110-2024-02-14).

## Unreleased

This release has an [MSRV][] of 1.65.

### Added

- [#339](https://github.com/linebender/kurbo/pull/339) - Add `From (f32, f32)` for `Point` by [@rsheeter](https://github.com/rsheeter)
- Add `From (f32, f32)` for `Point`. ([#339] by [@rsheeter])

### Changed

- [#340](https://github.com/linebender/kurbo/pull/340) - Move `Self: Sized` bound from `Shape` to methods by [@waywardmonkeys](https://github.com/waywardmonkeys)
- Move `Self: Sized` bound from `Shape` to methods. ([#340] by [@waywardmonkeys])

### Fixed

- [#343](https://github.com/linebender/kurbo/pull/343) - Allow lines in simplify input by [@raphlinus](https://github.com/raphlinus)
- An edge case in `mindist` was fixed. ([#334] by [@platlas])
- Allow lines in simplify input. ([#343] by [@raphlinus])
- Documentation for `Arc.perimeter` was corrected. ([#354] by [@simoncozens])

## [0.11.0][] (2024-02-14)

This release has an [MSRV][] of 1.65.

Note: A changelog was not kept for or before this release

[@platlas]: https://github.com/platlas
[@raphlinus]: https://github.com/raphlinus
[@rsheeter]: https://github.com/rsheeter
[@simoncozens]: https://github.com/simoncozens
[@waywardmonkeys]: https://github.com/waywardmonkeys

[#334]: https://github.com/linebender/kurbo/pull/334
[#339]: https://github.com/linebender/kurbo/pull/339
[#340]: https://github.com/linebender/kurbo/pull/340
[#343]: https://github.com/linebender/kurbo/pull/343
[#354]: https://github.com/linebender/kurbo/pull/354

## 0.11.0 (2024-02-14)
[Unreleased]: https://github.com/linebender/kurbo/compare/v0.11.0...HEAD
[0.11.0]: https://github.com/linebender/kurbo/releases/tag/v0.11.0

- ...
[MSRV]: README.md#minimum-supported-rust-version-msrv
4 changes: 3 additions & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ authors = ["Raph Levien <raph.levien@gmail.com>"]
license = "MIT OR Apache-2.0"
edition = "2021"
# TODO: When this hits 1.74, move lint configuration into this file via a lints table.
rust-version = "1.65" # When updating this, also update the README.md and CI.
# Keep in sync with RUST_MIN_VER in .github/workflows/ci.yml, with the README.md file,
# and with the MSRV in the `Unreleased` section of CHANGELOG.md.
rust-version = "1.65"
keywords = ["graphics", "curve", "curves", "bezier", "geometry"]
repository = "https://github.com/linebender/kurbo"
description = "A 2D curves library"
Expand Down
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,25 @@ There is a focus on accuracy and good performance in high-accuracy conditions. T

The library is still in fairly early development stages. There are traits intended to be useful for general curves (not just Béziers), but these will probably be reorganized.

## Minimum supported Rust version
## Minimum supported Rust Version (MSRV)

Since version 0.9, kurbo makes use of generic associated types and thus requires **rustc version 1.65 or greater.**
This version of Kurbo has been verified to compile with **Rust 1.65** and later.

Future versions of Kurbo might increase the Rust version requirement.
It will not be treated as a breaking change and as such can even happen with small patch releases.

<details>
<summary>Click here if compiling fails.</summary>

As time has passed, some of Kurbo's dependencies could have released versions with a higher Rust requirement.
If you encounter a compilation issue due to a dependency and don't want to upgrade your Rust toolchain, then you could downgrade the dependency.

```sh
# Use the problematic dependency's name and version
cargo update -p package_name --precise 0.1.1
```

</details>

## Similar crates

Expand Down