Document fornax format, update .gitignore

3 files changed, 57 insertions, 3 deletions

diff --git a/.gitignore b/.gitignore
index f018cd5..ee57f83 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 .precomp
 output/
 .log
+*.fornax
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
diff --git a/README.org b/README.org
index 131bc61..b2b6778 100644
--- a/README.org
+++ b/README.org
@@ -7,6 +7,30 @@
 | Source          | https://git.unfla.me/fornax              |
 | 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.
+
+* Fornax Format
+
+Fornax format is an intermediate output file generated after solving the
+maze. Algorithms must output the solution in this format.
+
+#+begin_src
+rows:<number of rows> cols:<number of columns> iterations:<number of iterations>
+
+...iterations
+#+end_src
+
+~...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.
+
 * Project Structure
 
 - Algorithms are located in ~algorithms/~ directory, sub-directory needs