diff --git a/CHANGELOG.md b/CHANGELOG.md index b5922c0..05a9209 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,12 +5,15 @@ This project adheres to [Semantic Versioning](http://semver.org/). This file follows the convention described at [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). -## [Unreleased] +## [0.18.0] - 2023-04-15 ### Changed - **Breaking**: jshrake: Add `map` argument to `import_image_pixels()` and change `pixels` argument to a byte slice rather than a vector reference. ### Added - jshrake: Add `MagickAutoGammaImage` and `MagickAutoLevelImage` +- 2e0by0: add API documentation and setup automated build of docs. +### Fixed +- BeatButton: prevent segfault if `MagickGetImageBlob` returns `null` ## [0.17.0] - 2022-12-10 ### Added diff --git a/Cargo.toml b/Cargo.toml index 9567b84..2983398 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "magick_rust" -version = "0.17.0" +version = "0.18.0" authors = ["Nathan Fiedler "] description = "Selection of Rust bindings for the ImageMagick library." homepage = "https://github.com/nlfiedler/magick-rust" @@ -14,7 +14,7 @@ build = "build.rs" libc = "0.2" [build-dependencies] -bindgen = "0.63" +bindgen = "0.65.1" pkg-config = "0.3" [features] diff --git a/README.md b/README.md index 26dcad5..6bfed79 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,6 @@ A somewhat safe Rust interface to the [ImageMagick](http://www.imagemagick.org/) system, in particular, the MagickWand library. Many of the functions in the MagickWand API are still missing, but over time more will be added. Pull requests are welcome. -## Documentation - -Documentation for upstream is hosted on [github pages](https://nlfiedler.github.io/magick-rust). To build locally run `cargo doc`. - ## Dependencies * Rust stable @@ -66,9 +62,13 @@ error: aborting due to previous error See [issue 40](https://github.com/nlfiedler/magick-rust/issues/40) on GitHub for some background. The issue seems to be that with HDRI disabled, rust-bindgen will not produce the bindings needed for the "quantum range" feature of ImageMagick (see [issue 316](https://github.com/rust-lang/rust-bindgen/issues/316)). To work-around this issue, you can disable HDRI support in your `Cargo.toml` file, like so: ``` -magick_rust = { version = "0.17.0", features = ["disable-hdri"] } +magick_rust = { version = "0.18.0", features = ["disable-hdri"] } ``` +## Documentation + +The API documentation is available at [github pages](https://nlfiedler.github.io/magick-rust) since the docs.rs system has a hard time building anything that requires an external library that is not wrapped in a "sys" style library. See [issue 57](https://github.com/nlfiedler/magick-rust/issues/57) for the "create a sys crate request." + ## Example Usage MagickWand has some global state that needs to be initialized prior to using the library, but fortunately Rust makes handling this pretty easy. In the example below, we read in an image from a file and resize it to fit a square of 240 by 240 pixels, then convert the image to JPEG.