diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 35 |
1 files changed, 32 insertions, 3 deletions
diff --git a/README b/README index d71cd78..cc0c2e0 100644 --- a/README +++ b/README @@ -10,7 +10,8 @@ Table of Contents ───────────────── -Project Structure +1. Fornax Format +2. Project Structure ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ @@ -19,9 +20,37 @@ Project Structure GitHub (mirror) <https://github.com/andinus/fornax> ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +This collection includes: +• `fornax': Program that parses /Fornax Format/ and outputs video + solution. +• Algorithms: Various algorithms solved in several programming + languages. -Project Structure -═════════════════ + +1 Fornax Format +═══════════════ + + Fornax format is an intermediate output file generated after solving + the maze. Algorithms must output the solution in this format. + + ┌──── + │ rows:<number of rows> cols:<number of columns> iterations:<number of iterations> + │ + │ ...iterations + └──── + + `...iterations' is to be replaced by the resulting grid in each + iteration that is to be included in the final video. Since the number + of rows and columns is known, the whole grid should be printed in a + single line. + + • Every iteration should be separated by a newline. + • If the iteration cells is not equal to `rows * columns' then it may + be ignored by the program that parses the file. + + +2 Project Structure +═══════════════════ • Algorithms are located in `algorithms/' directory, sub-directory needs to be created for programming languages which will hold the |