diff --git a/CHANGELOG.md b/CHANGELOG.md index 12bbfc9..b4c9f3c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,4 +13,14 @@ - Step Solve and Instant Solve options. - Option to change Animation Speed. - Option to change Maze Size. -- MVC Style Architecture \ No newline at end of file +- MVC Style Architecture + +## [unreleased] + +### Added +- Added `.clang-tidy` that implements basic `Checks` like `cppcoreguidelines`, `modernize` and `readability` etc along with basic naming-conventions for Classes, Functions and Variables. +- Added `CHANGELOG.md` to document all notable changes in a particular commit or release. +- Added `.pre-commit-config.yaml` to automate formatting, linting, analysing, spell-correction, and other pesky tasks & checklist (install using `pre-commit install`). + +### Changed +- Customized `.clang-format` for C++, away from pure LLVM coding-style. See [ClangFormatStyleOptions](https://clang.llvm.org/docs/ClangFormatStyleOptions.html) for more on what each does. tl;dr, it's just better? alignment and four-space tab. pro-tip: use empty line to separate two blocks of declarations. diff --git a/README.md b/README.md index 5b9df18..ae41d5b 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,10 @@ A sophisticated micromouse maze simulator featuring pathfinding algorithms and i --- +## Demo + +![demo gif](./assets/demo.gif) + ## Features ### Maze Generators diff --git a/assets/demo.gif b/assets/demo.gif new file mode 100644 index 0000000..eafff3a Binary files /dev/null and b/assets/demo.gif differ