Merge branch 'readme-update'

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2024-05-29
+
+### Added
+- Trim trailing whitespace from input rows; increase robustness.
+
 ## [0.2.0] - 2024-05-29
 
 ### Added
@@ -41,7 +46,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Dragon routing based on shortest path to current hero position.
 - Playback solution.
 
-[unreleased]: https://github.com/mkouhia/wundernut-vol13/compare/v0.2.0...HEAD
+[unreleased]: https://github.com/mkouhia/wundernut-vol13/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/mkouhia/wundernut-vol13/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/mkouhia/wundernut-vol13/compare/v0.1.2...v0.2.0
 [0.1.2]: https://github.com/mkouhia/wundernut-vol13/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/mkouhia/wundernut-vol13/compare/v0.1.0...v0.1.1

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "wundernut-vol13"
-version = "0.2.0"
+version = "0.2.1"
 authors = ["Mikko Kouhia <[email protected]>"]
 edition = "2021"
 description = "Solution to Wundernut vol. 13"

README.md

@@ -32,6 +32,21 @@ If necessary, consult the program help in
 
     solve-maze --help
 
+```
+Solution to Wundernut vol. 13
+
+Usage: solve-maze [OPTIONS] <FILE>
+
+Arguments:
+  <FILE>  File, where to read the maze. Use `-` for stdin
+
+Options:
+  -p, --playback                     Display solution on the terminal
+  -f, --frame-length <FRAME_LENGTH>  Playback frame length in milliseconds [default: 300]
+  -h, --help                         Print help
+  -V, --version                      Print version
+```
+
 ### Extras (additional fun factor)
 Additional feature `mapgen` will can generate more maps for an increased fun factor. Build with feature `mapgen` to create another binary `generate-maze`:
 
@@ -130,6 +145,20 @@ You can build the developer documentation with
 
     cargo doc
 
+### Code quality
+
+Code must be formatted with `rustfmt`:
+
+    rustfmt src/*.rs
+
+And quality checked with static analyzer `cargo clippy`:
+
+    cargo clippy
+
+An easy way to examine test coverage is to install additional cargo command with `cargo install cargo-llvm-cov` and then run
+
+    cargo llvm-cov --open
+
 ## License
 
 This project is licensed under the terms of the MIT license.

src/bin/generate-maze.rs

@@ -9,7 +9,7 @@ use wundernut_vol13::maze_generator::MazeGenerator;
 #[command(version, about, long_about = None)]
 struct Args {
     /// Generated field height
-    #[arg(long, default_value_t = 20)]
+    #[arg(long, default_value_t = 19)]
     height: usize,
 
     /// Generated field width

src/lib.rs

@@ -193,7 +193,7 @@ impl Maze {
 
         let squares: Vec<Vec<char>> = emojis
             .split('\n')
-            .map(|row| row.chars().collect())
+            .map(|row| row.trim_end().chars().collect())
             .collect();
 
         let mut graph = Graph {