diff options
| -rw-r--r-- | README | 89 | ||||
| -rw-r--r-- | README.org | 53 |
2 files changed, 78 insertions, 64 deletions
diff --git a/README b/README index e1d4189..af6327f 100644 --- a/README +++ b/README @@ -15,14 +15,12 @@ Table of Contents 3. Installation .. 1. Release .. 2. From Source -4. Project Structure -5. Documentation +4. Documentation .. 1. Options -6. Fornax Format -.. 1. Grids -.. 2. Maze (input) -.. 3. Solution (output) -7. News +.. 2. Fornax Format +.. 3. Project Structure +5. Bugs +6. News .. 1. v0.1.1 - 2021-11-16 .. 2. v0.1.0 - 2021-11-03 @@ -134,24 +132,7 @@ Writings: <https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc> -4 Project Structure -═══════════════════ - - • Algorithms are located in `algorithms/' directory, sub-directory - needs to be created for programming languages which will hold the - actual source. - - • Sample solutions can be found in `resources/solutions/' directory. - - • *Note*: Some solutions might output illegal moves (like walking - over blocked path), this error is only in visualization, the - solution is correct. - - This has been fixed in commit - `8cef86f0eb8b46b0ed2d7c37fa216890300249f6'. - - -5 Documentation +4 Documentation ═══════════════ Fornax parses /Fornax format/, generates a `PNG' for each iteration @@ -160,12 +141,8 @@ Writings: • Solved paths are highlighted if the iteration is preceded by `|'. • Illegal paths are highlighted if the iteration is preceded by `!'. - • *Note*: If the number of iterations are greater than an 8 digit - number then the slideshow might be incorrect. - • *Note*: `/tmp' must exist. - -5.1 Options +4.1 Options ─────────── • `input': This takes solved input file in the /Fornax/ format. @@ -174,16 +151,16 @@ Writings: • `batch': Number of iterations to process at once. -6 Fornax Format -═══════════════ +4.2 Fornax Format +───────────────── Fornax format defines 2 formats: • Maze (input) • Solution (output) -6.1 Grids -───────── +4.2.1 Grids +╌╌╌╌╌╌╌╌╌╌╌ A grid is printed for every iteration. Grids are composed of cells. @@ -201,8 +178,8 @@ Writings: ━━━━━━━━━━━━━━━━━━━━━━━━━━ -6.2 Maze (input) -──────────────── +4.2.2 Maze (input) +╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌ Maze input must be in this format: ┌──── @@ -213,8 +190,8 @@ Writings: input file or it ask the user. -6.3 Solution (output) -───────────────────── +4.2.3 Solution (output) +╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌ Fornax solution format is an intermediate output file generated after solving the maze. Algorithms must output the solution in this format: @@ -243,10 +220,40 @@ Writings: • First iteration is assumed to be the maze. -7 News +4.3 Project Structure +───────────────────── + + • Algorithms are located in `algorithms/' directory, sub-directory + needs to be created for programming languages which will hold the + actual source. + + • Sample solutions can be found in `resources/solutions/' directory. + + • *Note*: Some solutions might output illegal moves (like walking + over blocked path), this error is only in visualization, the + solution is correct. + + This has been fixed in commit + `8cef86f0eb8b46b0ed2d7c37fa216890300249f6'. + + +5 Bugs +══════ + + • If the number of iterations are greater than an 8 digit number then + the slideshow might be incorrect. + + • `/tmp' is assumed to exist. + + • Might panic with: `MoarVM oops: MVM_str_hash_entry_size called with + a stale hashtable pointer'. This has been fixed: + <https://github.com/rakudo/rakudo/pull/4634>. + + +6 News ══════ -7.1 v0.1.1 - 2021-11-16 +6.1 v0.1.1 - 2021-11-16 ─────────────────────── ⁃ Add option to skip generating slideshow. @@ -259,7 +266,7 @@ Writings: ⁃ Add more solutions. -7.2 v0.1.0 - 2021-11-03 +6.2 v0.1.0 - 2021-11-03 ─────────────────────── ⁃ Initial implementation: diff --git a/README.org b/README.org index f182f03..ec8d3f0 100644 --- a/README.org +++ b/README.org @@ -86,21 +86,6 @@ cd fornax zef install . #+end_src -* Project Structure - -- Algorithms are located in ~algorithms/~ directory, sub-directory needs - to be created for programming languages which will hold the actual - source. - -- Sample solutions can be found in ~resources/solutions/~ directory. - - - *Note*: Some solutions might output illegal moves (like walking over - blocked path), this error is only in visualization, the solution is - correct. - - This has been fixed in commit - ~8cef86f0eb8b46b0ed2d7c37fa216890300249f6~. - * Documentation Fornax parses /Fornax format/, generates a ~PNG~ for each iteration which is @@ -109,10 +94,6 @@ later converted to a slideshow with ~ffmpeg~. - Solved paths are highlighted if the iteration is preceded by ~|~. - Illegal paths are highlighted if the iteration is preceded by ~!~. -- *Note*: If the number of iterations are greater than an 8 digit number - then the slideshow might be incorrect. -- *Note*: ~/tmp~ must exist. - ** Options - ~input~: This takes solved input file in the /Fornax/ format. @@ -120,13 +101,13 @@ later converted to a slideshow with ~ffmpeg~. - ~skip-video~: Skip generating the video solution. - ~batch~: Number of iterations to process at once. -* Fornax Format +** Fornax Format Fornax format defines 2 formats: - Maze (input) - Solution (output) -** Grids +*** Grids A grid is printed for every iteration. Grids are composed of cells. @@ -141,7 +122,7 @@ A grid is printed for every iteration. Grids are composed of cells. | Current Path | ~~~ | | Current Position | ~@~ | -** Maze (input) +*** Maze (input) Maze input must be in this format: #+begin_src @@ -151,7 +132,7 @@ Maze input must be in this format: It is upto the program to infer the number of rows & columns from the input file or it ask the user. -** Solution (output) +*** Solution (output) Fornax solution format is an intermediate output file generated after solving the maze. Algorithms must output the solution in this format: @@ -178,6 +159,32 @@ columns is known, the whole grid should be printed in a single line. - First iteration is assumed to be the maze. +** Project Structure + +- Algorithms are located in ~algorithms/~ directory, sub-directory needs + to be created for programming languages which will hold the actual + source. + +- Sample solutions can be found in ~resources/solutions/~ directory. + + - *Note*: Some solutions might output illegal moves (like walking over + blocked path), this error is only in visualization, the solution is + correct. + + This has been fixed in commit + ~8cef86f0eb8b46b0ed2d7c37fa216890300249f6~. + +* Bugs + +- If the number of iterations are greater than an 8 digit number then + the slideshow might be incorrect. + +- ~/tmp~ is assumed to exist. + +- Might panic with: ~MoarVM oops: MVM_str_hash_entry_size called with a + stale hashtable pointer~. This has been fixed: + https://github.com/rakudo/rakudo/pull/4634. + * News ** v0.1.1 - 2021-11-16 |