README.md in subparry_labyrinth_solver-1.0.4 vs README.md in subparry_labyrinth_solver-1.1.0
- old
+ new
@@ -8,14 +8,12 @@
Fun little project about labyrinth solving inspired in mice that find cheese in a maze.
It exposes some classes to create a labyrinth and then find the path to the cheese.
-Be advised: **It does not support labyrinths with circular paths and if you try to solve one of these, it will result in an infinite loop**.
+Note that although the paths found are mostly efficient, the algorithm does not focus on finding **the best** path to the cheese.
-That being said, I plan to support that kind of labyrinths soon.
-
## Usage
```
gem install subparry_labyrinth_solver
```
@@ -38,11 +36,11 @@
{ up: true, down: false, right: true, left: false },
{ up: true, down: false, right: false, left: true }
]
]
-# This data represents this maze:
+# The above data represents this maze:
# ___ ___
# | | 🧀|
# | | |
# | |
# |_______|
@@ -70,8 +68,8 @@
# corner is x: 0, y: 0 and bottom-right is x: width, y: length
```
## Pending
-- Support labyrinths with circular paths
- Create a labyrinth maker class
- Visual representation of labyrinths
+- Document Node and Labyrinth classes