From 55e355c0a32de0bcf12f4a52ae7ac3b072f0bf66 Mon Sep 17 00:00:00 2001
From: Andinus <andinus@nand.sh>
Date: Wed, 3 Nov 2021 23:04:27 +0530
Subject: Add installation notes to README

---
 README | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 72 insertions(+), 10 deletions(-)

(limited to 'README')

diff --git a/README b/README
index e3be23d..94668f8 100644
--- a/README
+++ b/README
@@ -11,11 +11,16 @@ Table of Contents
 ─────────────────
 
 1. Demo
-2. Documentation
-3. Project Structure
-4. Fornax Format
+2. Installation
+.. 1. Release
+.. 2. From Source
+..... 1. Without `git'
+..... 2. With `git'
+3. Documentation
+4. Project Structure
+5. Fornax Format
 .. 1. Grids
-5. News
+6. News
 .. 1. v0.1.0 - 2021-11-03
 
 
@@ -44,7 +49,64 @@ This collection includes:
 <https://andinus.unfla.me/resources/projects/fornax/2021-11-03-DFS-33.mp4>
 
 
-2 Documentation
+2 Installation
+══════════════
+
+  `fornax' is written in Raku, it can be installed with `zef'. You can
+  also run it without `zef', just run `raku -Ilib bin/fornax' from
+  within the source directory.
+
+  • *Note*: `Cairo' module & `ffmpeg' program is required.
+
+
+2.1 Release
+───────────
+
+  1. Run `zef install fornax'.
+
+  Fornax should be installed, try running `fornax --version' to confirm.
+
+  • Solving programs / solutions are not included in the distribution,
+    get them from this repository.
+
+
+2.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'
+╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
+
+  1. Download the release:
+     • <https://git.unfla.me/andinus/fornax>
+     • <https://github.com/andinus/fornax/releases>
+  2. Extract the file.
+  3. Run `zef install .' in source directory.
+
+
+2.2.2 With `git'
+╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
+
+  All commits by /Andinus/ will be signed by this [PGP Key].
+
+  ┌────
+  │ # Clone the project.
+  │ git clone https://git.tilde.institute/andinus/fornax
+  │ cd fornax
+  │
+  │ # Install fornax.
+  │ zef install .
+  └────
+
+
+[PGP Key]
+<https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc>
+
+
+3 Documentation
 ═══════════════
 
   Fornax parses /Fornax format/, generates a `PNG' for each iteration
@@ -57,7 +119,7 @@ This collection includes:
     number then the slideshow might be incorrect.
 
 
-3 Project Structure
+4 Project Structure
 ═══════════════════
 
   • Algorithms are located in `algorithms/' directory, sub-directory
@@ -74,7 +136,7 @@ This collection includes:
       `8cef86f0eb8b46b0ed2d7c37fa216890300249f6'.
 
 
-4 Fornax Format
+5 Fornax Format
 ═══════════════
 
   Fornax format is an intermediate output file generated after solving
@@ -105,7 +167,7 @@ This collection includes:
   • First iteration is assumed to be the maze.
 
 
-4.1 Grids
+5.1 Grids
 ─────────
 
   A grid is printed for every iteration. Grids are composed of cells.
@@ -125,10 +187,10 @@ This collection includes:
     symbol if it makes sense.
 
 
-5 News
+6 News
 ══════
 
-5.1 v0.1.0 - 2021-11-03
+6.1 v0.1.0 - 2021-11-03
 ───────────────────────
 
   ⁃ Initial implementation. Includes DFS solver in Java, tool to
-- 
cgit 1.4.1-2-gfad0