0.15.0

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+## 0.15.0
+
 * Bumped `bevy`, `bevy_egui` and `bevy_inspector_egui` dev dependencies
 * Bumped `glam` to 0.25
 * Dropped MSRV

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "hexx"
-version = "0.14.0"
+version = "0.15.0"
 edition = "2021"
 authors = ["Felix de Maneville <[email protected]>"]
 description = "Hexagonal utilities"

README.md

@@ -7,7 +7,7 @@
 [![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
 [![Crates.io](https://img.shields.io/crates/v/hexx.svg)](https://crates.io/crates/hexx)
 [![Docs.rs](https://docs.rs/hexx/badge.svg)](https://docs.rs/hexx)
-[![dependency status](https://deps.rs/crate/hexx/0.14.0/status.svg)](https://deps.rs/crate/hexx)
+[![dependency status](https://deps.rs/crate/hexx/0.15.0/status.svg)](https://deps.rs/crate/hexx)
 
 <!-- cargo-sync-readme start -->
 
@@ -18,9 +18,9 @@
 
  This lib allows you to:
 
- - Manipulate hexagon coordinates
- - Generate hexagonal maps with custom layouts and orientation
- - Generate hexagon meshes (planes or columns)
+ * Manipulate hexagon coordinates
+ * Generate hexagonal maps with custom layouts and orientation
+ * Generate hexagon meshes (planes or columns)
 
  I made the choice to use *Axial Coordinates* for performance and utility
  reasons, but the [`Hex`] type has conversion utilities with *cubic*,
@@ -33,50 +33,50 @@
  Run `cargo add hexx` in your project or add the following line to your
  `Cargo.toml`:
 
- - `hexx = "0.14"`
+ * `hexx = "0.15"`
 
  ### Cargo features
 
  `hexx` supports serialization and deserialization of most types using [serde](https://github.com/serde-rs/serde),
  through the `serde` feature gate. To enable it add the following line to
  your `Cargo.toml`:
 
- - `hexx = { version = "0.14", features = ["serde"] }`
+ * `hexx = { version = "0.15", features = ["serde"] }`
 
  By default `Hex` uses rust classic memory layout, if you want to use `hexx`
  through the FFI or have `Hex` be stored without any memory padding, the
  `packed` feature will make `Hex` `repr(C)`. To enable this behaviour add the
  following line to your `Cargo.toml`:
 
- - `hexx = { version = "0.14", features = ["packed"] }`
+ * `hexx = { version = "0.15", features = ["packed"] }`
 
  `hexx` supports [Bevy Reflection](https://docs.rs/bevy_reflect/latest/bevy_reflect) through the
  `bevy_reflect` feature. To enable it add the following line to your
  `Cargo.toml`:
 
- - `hexx = { version = "0.14", features = ["bevy_reflect"] }`
+ * `hexx = { version = "0.15", features = ["bevy_reflect"] }`
 
  ## Features
 
  `hexx` provides the [`Hex`] coordinates with:
 
- - Distances
- - Neighbors and directions
- - Lines
- - Ranges
- - Rings
- - Edges
- - Wedges
- - Spirals
- - Rotation
- - Symmetry
- - Vector operations
- - Conversions to other coordinate systems:
-     - Cubic coordinates
-     - Offset coordinates
-     - Doubled coordinates
-     - Hexmod coordinates
- - Multiple hex resolution
+ * Distances
+ * Neighbors and directions
+ * Lines
+ * Ranges
+ * Rings
+ * Edges
+ * Wedges
+ * Spirals
+ * Rotation
+ * Symmetry
+ * Vector operations
+ * Conversions to other coordinate systems:
+     * Cubic coordinates
+     * Offset coordinates
+     * Doubled coordinates
+     * Hexmod coordinates
+ * Multiple hex resolution
 
  ## Basic usage
 
@@ -151,8 +151,9 @@
  [`Hex`] support multi-resolution coordinates.
  In practice this means that you may convert a coordinate to a different
  resolution:
- - To a lower resolution, meaning retrieving a *parent* coordinate
- - to a higher resolution, meaning retrieving the center *child* coordinate
+
+ * To a lower resolution, meaning retrieving a *parent* coordinate
+ * to a higher resolution, meaning retrieving the center *child* coordinate
 
  Resolutions are abstract, the only useful information is the resolution
  **radius**.

src/lib.rs

@@ -5,9 +5,9 @@
 //!
 //! This lib allows you to:
 //!
-//! - Manipulate hexagon coordinates
-//! - Generate hexagonal maps with custom layouts and orientation
-//! - Generate hexagon meshes (planes or columns)
+//! * Manipulate hexagon coordinates
+//! * Generate hexagonal maps with custom layouts and orientation
+//! * Generate hexagon meshes (planes or columns)
 //!
 //! I made the choice to use *Axial Coordinates* for performance and utility
 //! reasons, but the [`Hex`] type has conversion utilities with *cubic*,
@@ -20,50 +20,50 @@
 //! Run `cargo add hexx` in your project or add the following line to your
 //! `Cargo.toml`:
 //!
-//! - `hexx = "0.14"`
+//! * `hexx = "0.15"`
 //!
 //! ### Cargo features
 //!
 //! `hexx` supports serialization and deserialization of most types using [serde](https://github.com/serde-rs/serde),
 //! through the `serde` feature gate. To enable it add the following line to
 //! your `Cargo.toml`:
 //!
-//! - `hexx = { version = "0.14", features = ["serde"] }`
+//! * `hexx = { version = "0.15", features = ["serde"] }`
 //!
 //! By default `Hex` uses rust classic memory layout, if you want to use `hexx`
 //! through the FFI or have `Hex` be stored without any memory padding, the
 //! `packed` feature will make `Hex` `repr(C)`. To enable this behaviour add the
 //! following line to your `Cargo.toml`:
 //!
-//! - `hexx = { version = "0.14", features = ["packed"] }`
+//! * `hexx = { version = "0.15", features = ["packed"] }`
 //!
 //! `hexx` supports [Bevy Reflection](https://docs.rs/bevy_reflect/latest/bevy_reflect) through the
 //! `bevy_reflect` feature. To enable it add the following line to your
 //! `Cargo.toml`:
 //!
-//! - `hexx = { version = "0.14", features = ["bevy_reflect"] }`
+//! * `hexx = { version = "0.15", features = ["bevy_reflect"] }`
 //!
 //! ## Features
 //!
 //! `hexx` provides the [`Hex`] coordinates with:
 //!
-//! - Distances
-//! - Neighbors and directions
-//! - Lines
-//! - Ranges
-//! - Rings
-//! - Edges
-//! - Wedges
-//! - Spirals
-//! - Rotation
-//! - Symmetry
-//! - Vector operations
-//! - Conversions to other coordinate systems:
-//!     - Cubic coordinates
-//!     - Offset coordinates
-//!     - Doubled coordinates
-//!     - Hexmod coordinates
-//! - Multiple hex resolution
+//! * Distances
+//! * Neighbors and directions
+//! * Lines
+//! * Ranges
+//! * Rings
+//! * Edges
+//! * Wedges
+//! * Spirals
+//! * Rotation
+//! * Symmetry
+//! * Vector operations
+//! * Conversions to other coordinate systems:
+//!     * Cubic coordinates
+//!     * Offset coordinates
+//!     * Doubled coordinates
+//!     * Hexmod coordinates
+//! * Multiple hex resolution
 //!
 //! ## Basic usage
 //!
@@ -138,8 +138,9 @@
 //! [`Hex`] support multi-resolution coordinates.
 //! In practice this means that you may convert a coordinate to a different
 //! resolution:
-//! - To a lower resolution, meaning retrieving a *parent* coordinate
-//! - to a higher resolution, meaning retrieving the center *child* coordinate
+//!
+//! * To a lower resolution, meaning retrieving a *parent* coordinate
+//! * to a higher resolution, meaning retrieving the center *child* coordinate
 //!
 //! Resolutions are abstract, the only useful information is the resolution
 //! **radius**.