Skip to content
This repository was archived by the owner on Sep 29, 2023. It is now read-only.

Commit 3e4af3f

Browse files
Document Formatting Fixes
Fixed minor formatting errors in the documentation that occurred while migrating from GitLab to GitHub.
1 parent 920dbca commit 3e4af3f

File tree

16 files changed

+32
-69
lines changed

16 files changed

+32
-69
lines changed

changelog.md

Lines changed: 6 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,15 @@
11
# Changelog
22

3-
**Moved Files**
4-
* Command Root
5-
* **From:** ./info/command-root.md
6-
* **To:** ./info/commands/readme.md
7-
* Input Root
8-
* **From:** ./info/input-root.md
9-
* **To:** ./info/input-types/readme.md
10-
* Pathfinding Modes
11-
* **From:** ./info/pathfinding-modes.md
12-
* **To:** ./info/pathfinding-modes/readme.md
13-
14-
---
15-
16-
**./readme.md**
17-
* Added a link to Dr. Mike Pound's GitHub page.
18-
* Changed "cloning/pulling a local copy of" to "downloading"
19-
* Corrected documentation page links.
20-
* Simplified license description.
21-
* Added link to MIT license.
22-
* Corrected "non-commericial" typo.
23-
* Added horizontal rules between sections.
24-
25-
---
26-
27-
**./info/readme.md**
28-
* New file - Navigation page for 'info' folder.
3+
**./info/%subfolder%/readme.md**
4+
* "Return to index" now links back to the project root.
295

306
---
317

328
**./info/commands/**
33-
* readme.md
34-
* Corrected links to individual commands.
35-
* "Return to index" now links to the '../info' folder instead of the project root.
36-
* Others
37-
* Regenerated argument table definition code. (Full instead of Compact)
38-
* Corrected link to command list root.
39-
40-
---
41-
42-
**./info/input-types/**
43-
* readme.md
44-
* Corrected links to individual input type pages.
45-
* "Return to index" now links to the '../info' folder instead of the project root.
46-
* Others
47-
* Corrected link to input type list root.
48-
* Added horizontal rules between sections.
9+
* Added line break between 'Usage' and 'Example' for individual commands.
4910

5011
---
5112

52-
**./info/pathfinding-modes/readme.md**
53-
* Regenerated argument table definition code. (Full instead of Compact)
54-
* Escaped square brackets when referring to 'pathfinding-mode'
55-
* Added link back to '../info' folder.
13+
**./info/input-types/image-config.md**
14+
* Recompiled 'Properties' table definition code.
15+
* Full instead of compact.

info/commands/create-image-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## create-image-config
2-
**Usage:** `maze create-image-config [options] [output-path]`
2+
**Usage:** `maze create-image-config [options] [output-path]`
33
**Example:** `maze create-image-config ./result.json --wall #000000 --floor #FFFFFF`
44

55
Creates a configuration file that can be used when reading images.

info/commands/grid-to-absolute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## grid-to-absolute
2-
**Usage:** `maze grid-to-absolute [options] <input-grid> [output-path]`
2+
**Usage:** `maze grid-to-absolute [options] <input-grid> [output-path]`
33
**Example:** `maze grid-to-absolute ./examples/grid/input.txt ./output.txt -r`
44

55
Takes an existing Grid definition text file, parses it into a graph, and outputs an Absolute definition text file.

info/commands/image-to-absolute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## image-to-absolute
2-
**Usage:** `maze image-to-absolute [options] <input-image> [output-path]`
2+
**Usage:** `maze image-to-absolute [options] <input-image> [output-path]`
33
**Example:** `maze image-to-absolute ./examples/image/small.png ./output.txt -r`
44

55
Takes an existing Image file, parses it into a graph, and outputs an Absolute definition text file.

info/commands/image-to-grid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## image-to-grid
2-
**Usage:** `maze image-to-grid [options] <input-image> [output-path]`
2+
**Usage:** `maze image-to-grid [options] <input-image> [output-path]`
33
**Example:** `maze image-to-grid ./examples/image/small.png ./output.txt -r`
44

55
Takes an existing image file, parses it into a grid, and outputs it as a definition text file.

info/commands/map-absolute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## map-absolute
2-
**Usage:** `maze map-absolute [options] <input-path> [pathfinding-mode]`
2+
**Usage:** `maze map-absolute [options] <input-path> [pathfinding-mode]`
33
**Example:** `maze map-absolute ./examples/absolute/input.txt dsktra`
44

55
Takes an absolute node graph text file, converts it into an interactive diagram, and performs a pathfinding algorithm.

info/commands/map-grid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## map-grid
2-
**Usage:** `maze map-grid [options] <input-path> [pathfinding-mode]`
2+
**Usage:** `maze map-grid [options] <input-path> [pathfinding-mode]`
33
**Example:** `maze map-grid ./examples/grid/input.txt dsktra`
44

55
Takes a predefined binary grid text file, converts it into an interactive diagram, and performs a pathfinding algorithm.

info/commands/map-image.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## map-image
2-
**Usage:** `maze map-image [options] <input-path> [pathfinding-mode]`
2+
**Usage:** `maze map-image [options] <input-path> [pathfinding-mode]`
33
**Example:** `maze map-image ./examples/image/small.png dsktra`
44

55
Takes an existing image file of a maze, converts it into an interactive diagram, and performs a pathfinding algorithm.

info/commands/map-relative.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## map-relative
2-
**Usage:** `maze map-relative [options] <input-path> [pathfinding-mode]`
2+
**Usage:** `maze map-relative [options] <input-path> [pathfinding-mode]`
33
**Example:** `maze map-relative ./examples/relative/input.txt all-possible`
44

55
Takes a relative node graph text file, converts it into an interactive diagram, and performs a pathfinding algorithm.

info/commands/read-image-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## read-image-config
2-
**Usage:** `maze read-image-config <file-path>`
2+
**Usage:** `maze read-image-config <file-path>`
33
**Example:** `maze read-image-config ./templates/image-config.json`
44

55
Reads and validates an existing image configuration file.

0 commit comments

Comments
 (0)