From 6acf653f443247a76fb767731eb2bdbc90bbb066 Mon Sep 17 00:00:00 2001
From: Andinus <andinus@nand.sh>
Date: Wed, 3 Nov 2021 16:25:57 +0530
Subject: Document fornax format, update .gitignore

---
 README | 35 ++++++++++++++++++++++++++++++++---
 1 file changed, 32 insertions(+), 3 deletions(-)

(limited to 'README')

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
-- 
cgit 1.4.1-2-gfad0