Mercurial > public > maze-solver
changeset 13:f05cad159c7b
Change info files
| author | Dennis <dennis@denniscm.com> |
|---|---|
| date | Fri, 11 Aug 2023 18:08:52 +0000 |
| parents | d1fc48c5de99 |
| children | 06050949285b |
| files | DOCS.md LICENSE.md README.md |
| diffstat | 3 files changed, 37 insertions(+), 21 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/DOCS.md Fri Aug 11 18:08:52 2023 +0000 @@ -0,0 +1,28 @@ + +# Table of Contents + +1. [Constraints](#org007cf9f) +2. [Usage](#org77279b7) + + +<a id="org007cf9f"></a> + +# Constraints + +- Only PNG files +- Mazes should be square +- Walls should be black `rgb(0, 0, 0)` and path white `rg(255, 255, 255)` +- Walls and path should be `1px` width +- The starting point must be at `(x: 0, y: 1)` +- The ending point should be at `(x: width, y: height - 1)` + + +<a id="org77279b7"></a> + +# Usage + +- Build executable +- Make a folder named `mazes` and place your mazes there +- Make a folder named `sols`. The script place the solutions here +- Run the program `./maze_solver maze1.png` +
--- a/LICENSE.md Wed Aug 02 08:11:29 2023 +0100 +++ b/LICENSE.md Fri Aug 11 18:08:52 2023 +0000 @@ -19,3 +19,4 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +
--- a/README.md Wed Aug 02 08:11:29 2023 +0100 +++ b/README.md Fri Aug 11 18:08:52 2023 +0000 @@ -1,27 +1,14 @@ + # maze-solver A maze solver written in C. -## Constraints -- Only PNG files -- Mazes must be square -- Walls must be black `rgb(0, 0, 0)` and path white `rgb(255, 255, 255)` -- Walls and path must be `1 px` width -- The starting point must be at `(x: 0, y: 1)` -- The ending point must be at `(x: width, y: height - 1)` - -## Usage + + -1. Build executable -2. Make a folder names `mazes` and place your mazes there. -3. Make a folder named `sols`. The script place the solutions here. -4. Run the program `./maze_solver maze1.png` +- Docs: <https://denniscm.com/proj/maze-solver.html> +- Main repo on SourceHut: <https://git.sr.ht/~denniscmartin/maze-solver> + - Mirrors: + - Github: <https://github.com/denniscmartin/maze-solver> + - Gitlab: <https://gitlab.com/denniscmartin/maze-solver> - - - -## Resources -- [Maze generator](https://keesiemeijer.github.io/maze-generator/#generate) -- [Libpng example](http://zarb.org/~gc/html/libpng.html) -- [Libpng manual](http://www.libpng.org/pub/png/libpng-1.2.5-manual.html) -- [Inspired by Dr Mike Pound (Computerphile video)](https://www.youtube.com/watch?v=rop0W4QDOUI)