Add usage instructions

1 files changed, 33 insertions, 20 deletions

diff --git a/README b/README
index 3a9352a..e1d4189 100644
--- a/README
+++ b/README
@@ -11,17 +11,18 @@ Table of Contents
 ─────────────────
 
 1. Demo
-2. Installation
+2. Usage
+3. Installation
 .. 1. Release
 .. 2. From Source
-3. Project Structure
-4. Documentation
+4. Project Structure
+5. Documentation
 .. 1. Options
-5. Fornax Format
+6. Fornax Format
 .. 1. Grids
 .. 2. Maze (input)
 .. 3. Solution (output)
-6. News
+7. News
 .. 1. v0.1.1 - 2021-11-16
 .. 2. v0.1.0 - 2021-11-03
 
@@ -64,7 +65,19 @@ Writings:
 <https://andinus.unfla.me/resources/projects/fornax/2021-11-16-DFS-60.mp4>
 
 
-2 Installation
+2 Usage
+═══════
+
+  ┌────
+  │ # Solve the maze.
+  │ raku algorithms/raku/DFS.raku resources/input/06 > /tmp/solution.fornax
+  │
+  │ # Visualize the solution.
+  │ raku -Ilib bin/fornax /tmp/solution.fornax
+  └────
+
+
+3 Installation
 ══════════════
 
   `fornax' is written in Raku, it can be installed with `zef'. You can
@@ -74,7 +87,7 @@ Writings:
   • *Note*: `Cairo' module & `ffmpeg' program is required.
 
 
-2.1 Release
+3.1 Release
 ───────────
 
   1. Run `zef install 'fornax:auth<zef:andinus>''
@@ -85,14 +98,14 @@ Writings:
     get them from this repository.
 
 
-2.2 From Source
+3.2 From Source
 ───────────────
 
   You can either download the release archive generated by cgit/GitHub
   or clone the project if you have `git' installed.
 
 
-2.2.1 Without `git'
+3.2.1 Without `git'
 ╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
 
   1. Download the release:
@@ -102,7 +115,7 @@ Writings:
   3. Run `zef install .' in source directory.
 
 
-2.2.2 With `git'
+3.2.2 With `git'
 ╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
 
   All commits by /Andinus/ will be signed by this [PGP Key].
@@ -121,7 +134,7 @@ Writings:
 <https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc>
 
 
-3 Project Structure
+4 Project Structure
 ═══════════════════
 
   • Algorithms are located in `algorithms/' directory, sub-directory
@@ -138,7 +151,7 @@ Writings:
       `8cef86f0eb8b46b0ed2d7c37fa216890300249f6'.
 
 
-4 Documentation
+5 Documentation
 ═══════════════
 
   Fornax parses /Fornax format/, generates a `PNG' for each iteration
@@ -152,7 +165,7 @@ Writings:
   • *Note*: `/tmp' must exist.
 
 
-4.1 Options
+5.1 Options
 ───────────
 
   • `input': This takes solved input file in the /Fornax/ format.
@@ -161,7 +174,7 @@ Writings:
   • `batch': Number of iterations to process at once.
 
 
-5 Fornax Format
+6 Fornax Format
 ═══════════════
 
   Fornax format defines 2 formats:
@@ -169,7 +182,7 @@ Writings:
   • Solution (output)
 
 
-5.1 Grids
+6.1 Grids
 ─────────
 
   A grid is printed for every iteration. Grids are composed of cells.
@@ -188,7 +201,7 @@ Writings:
   ━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 
-5.2 Maze (input)
+6.2 Maze (input)
 ────────────────
 
   Maze input must be in this format:
@@ -200,7 +213,7 @@ Writings:
   input file or it ask the user.
 
 
-5.3 Solution (output)
+6.3 Solution (output)
 ─────────────────────
 
   Fornax solution format is an intermediate output file generated after
@@ -230,10 +243,10 @@ Writings:
   • First iteration is assumed to be the maze.
 
 
-6 News
+7 News
 ══════
 
-6.1 v0.1.1 - 2021-11-16
+7.1 v0.1.1 - 2021-11-16
 ───────────────────────
 
   ⁃ Add option to skip generating slideshow.
@@ -246,7 +259,7 @@ Writings:
   ⁃ Add more solutions.
 
 
-6.2 v0.1.0 - 2021-11-03
+7.2 v0.1.0 - 2021-11-03
 ───────────────────────
 
   ⁃ Initial implementation: