diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 53 |
1 files changed, 30 insertions, 23 deletions
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 |