Remove output option, Define maze input format in README

2 files changed, 118 insertions, 77 deletions

diff --git a/README b/README
index 76c9420..3a9352a 100644
--- a/README
+++ b/README
@@ -12,10 +12,18 @@ Table of Contents
 
 1. Demo
 2. Installation
-3. Documentation
-4. Project Structure
+.. 1. Release
+.. 2. From Source
+3. Project Structure
+4. Documentation
+.. 1. Options
 5. Fornax Format
+.. 1. Grids
+.. 2. Maze (input)
+.. 3. Solution (output)
 6. News
+.. 1. v0.1.1 - 2021-11-16
+.. 2. v0.1.0 - 2021-11-03
 
 
 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
@@ -113,7 +121,24 @@ Writings:
 <https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc>
 
 
-3 Documentation
+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'.
+
+
+4 Documentation
 ═══════════════
 
   Fornax parses /Fornax format/, generates a `PNG' for each iteration
@@ -124,39 +149,62 @@ Writings:
 
   • *Note*: If the number of iterations are greater than an 8 digit
     number then the slideshow might be incorrect.
+  • *Note*: `/tmp' must exist.
 
 
-3.1 Options
+4.1 Options
 ───────────
 
   • `input': This takes solved input file in the /Fornax/ format.
-  • `frame-rate': Frame rate for the video.
-  • `output': Output directory (for solution video/images).
+  • `fps': Frame rate for the video solution.
+  • `skip-video': Skip generating the video solution.
+  • `batch': Number of iterations to process at once.
 
 
-4 Project Structure
-═══════════════════
+5 Fornax Format
+═══════════════
 
-  • Algorithms are located in `algorithms/' directory, sub-directory
-    needs to be created for programming languages which will hold the
-    actual source.
+  Fornax format defines 2 formats:
+  • Maze (input)
+  • Solution (output)
 
-  • 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.
+5.1 Grids
+─────────
 
-      This has been fixed in commit
-      `8cef86f0eb8b46b0ed2d7c37fa216890300249f6'.
+  A grid is printed for every iteration. Grids are composed of cells.
 
+  ━━━━━━━━━━━━━━━━━━━━━━━━━━
+   Cell              Symbol
+  ──────────────────────────
+   Path              `.'
+   Blocked           `#'
+   Start             `^'
+   Destination       `$'
+  ──────────────────────────
+   Visited           `-'
+   Current Path      `~'
+   Current Position  `@'
+  ━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-5 Fornax Format
-═══════════════
 
-  Fornax format is an intermediate output file generated after solving
-  the maze. Algorithms must output the solution in this format.
+5.2 Maze (input)
+────────────────
 
+  Maze input must be in this format:
+  ┌────
+  │ ...rows
+  └────
+
+  It is upto the program to infer the number of rows & columns from the
+  input file or it ask the user.
+
+
+5.3 Solution (output)
+─────────────────────
+
+  Fornax solution 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>
   │
@@ -182,28 +230,6 @@ Writings:
   • First iteration is assumed to be the maze.
 
 
-5.1 Grids
-─────────
-
-  A grid is printed for every iteration. Grids are composed of cells.
-
-  ━━━━━━━━━━━━━━━━━━━━━━━━━━
-   Cell              Symbol
-  ──────────────────────────
-   Path              `.'
-   Blocked           `#'
-   Start             `^'
-   Destination       `$'
-  ──────────────────────────
-   Visited           `-'
-   Current Path      `~'
-   Current Position  `@'
-  ━━━━━━━━━━━━━━━━━━━━━━━━━━
-
-  • /Current Position/ is prioritized over /Blocked/ & /Destination/
-    symbol if it makes sense.
-
-
 6 News
 ══════
 
diff --git a/README.org b/README.org
index 20a8b0b..5f580e8 100644
--- a/README.org
+++ b/README.org
@@ -1,7 +1,8 @@
 #+title: Fornax
 #+subtitle: Collection of tools to visualize Path Finding Algorithms
 #+export_file_name: index
-#+options: toc:1
+#+options: toc:2
+#+startup: overview
 #+setupfile: ~/.emacs.d/org-templates/projects.org
 
 | Website         | https://andinus.unfla.me/projects/fornax |
@@ -75,6 +76,21 @@ 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
@@ -85,33 +101,50 @@ later converted to a slideshow with ~ffmpeg~.
 
 - *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.
-- ~frame-rate~: Frame rate for the video.
-- ~output~: Output directory (for solution video/images).
+- ~fps~: Frame rate for the video solution.
+- ~skip-video~: Skip generating the video solution.
+- ~batch~: Number of iterations to process at once.
 
-* Project Structure
+* Fornax Format
 
-- Algorithms are located in ~algorithms/~ directory, sub-directory needs
-  to be created for programming languages which will hold the actual
-  source.
+Fornax format defines 2 formats:
+- Maze (input)
+- Solution (output)
 
-- Sample solutions can be found in ~resources/solutions/~ directory.
+** Grids
 
-  - *Note*: Some solutions might output illegal moves (like walking over
-    blocked path), this error is only in visualization, the solution is
-    correct.
+A grid is printed for every iteration. Grids are composed of cells.
 
-    This has been fixed in commit
-    ~8cef86f0eb8b46b0ed2d7c37fa216890300249f6~.
+| Cell             | Symbol |
+|------------------+--------|
+| Path             | ~.~      |
+| Blocked          | ~#~      |
+| Start            | ~^~      |
+| Destination      | ~$~      |
+|------------------+--------|
+| Visited          | ~-~      |
+| Current Path     | ~~~      |
+| Current Position | ~@~      |
 
-* Fornax Format
+** Maze (input)
+
+Maze input must be in this format:
+#+begin_src
+...rows
+#+end_src
 
-Fornax format is an intermediate output file generated after solving the
-maze. Algorithms must output the solution 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)
+
+Fornax solution 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>
 
@@ -135,24 +168,6 @@ columns is known, the whole grid should be printed in a single line.
 
 - First iteration is assumed to be the maze.
 
-** Grids
-
-A grid is printed for every iteration. Grids are composed of cells.
-
-| Cell             | Symbol |
-|------------------+--------|
-| Path             | ~.~      |
-| Blocked          | ~#~      |
-| Start            | ~^~      |
-| Destination      | ~$~      |
-|------------------+--------|
-| Visited          | ~-~      |
-| Current Path     | ~~~      |
-| Current Position | ~@~      |
-
-- /Current Position/ is prioritized over /Blocked/ & /Destination/ symbol if
-  it makes sense.
-
 * News
 
 ** v0.1.1 - 2021-11-16