From 2258b2eba4e28894baeaa2b1ccf5ab8a18a0220f Mon Sep 17 00:00:00 2001 From: Dnomd343 Date: Sat, 28 Dec 2024 09:06:33 +0800 Subject: [PATCH] docs: add CHANGELOG --- CHANGELOG.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0ea5a71 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,44 @@ +# Klotski Changelog + +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). + +## [Unreleased] + +### Added + +- Automatically generate metadata in header file. + +- New `analyse` module for analyzing BFS graph structures. + +- More test suites and performance benchmark suites. + +- More Python and Rust interfaces. + +### Changed + +- Performance optimization of some functions. + +- Internal structure and interfaces adjustment of core. + +- Using `Layout` instead of `CommonCode` in external interfaces. + +### Fixed + +- Avoid compiling C++ code when building on `docs.rs`. + +## [0.0.1] - 2024-11-16 + +### Added + +- Basic klotski functions, including `codec`, `cases`, `group`, `mover` and `fast_cal` modules. + +- Basic test suites and performance benchmark suites. + +- Preliminary Python interfaces for preview. + +- Preliminary Rust interfaces for preview. + +[unreleased]: https://github.com/dnomd343/klotski/compare/v0.0.1...HEAD +[0.0.1]: https://github.com/dnomd343/klotski/releases/tag/v0.0.1