Add v0.2.3 NEWS, Demo HEAD master

1 files changed, 82 insertions, 44 deletions

diff --git a/README b/README
index b190176..e4fc224 100644
--- a/README
+++ b/README
@@ -10,10 +10,28 @@
 Table of Contents
 ─────────────────
 
-Demo
-Installation
-Documentation
-News
+1. Demo
+2. Installation
+.. 1. Release
+.. 2. From Source
+..... 1. Without `git'
+..... 2. With `git'
+3. Documentation
+.. 1. Implementation
+.. 2. Options
+..... 1. dict
+..... 2. visualize
+..... 3. length
+..... 4. path
+..... 5. verbose
+4. News
+.. 1. v0.2.3 - 2022-01-12
+.. 2. v0.2.0 - 2021-03-04
+.. 3. v0.1.4 - 2021-02-19
+.. 4. v0.1.3 - 2021-01-24
+.. 5. v0.1.2 - 2021-01-20
+.. 6. v0.1.1 - 2021-01-20
+.. 7. v0.1.0 - 2021-01-19
 
 
 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
@@ -23,13 +41,15 @@ News
 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 
-Demo
-════
+1 Demo
+══════
 
   This was recorded with `asciinema'.
 
   [https://asciinema.org/a/385500.png]
 
+  ⁃ Octans v0.2.3: [Visualized Output]
+
   ⁃ Octans v0.1.0 - finds 10 solutions to a puzzle:
     <https://asciinema.org/a/385598>
   ⁃ Octans v0.1.0: <https://asciinema.org/a/385500>
@@ -40,9 +60,12 @@ Demo
 
 [https://asciinema.org/a/385500.png] <https://asciinema.org/a/385500>
 
+[Visualized Output]
+<https://andinus.unfla.me/resources/projects/octans/v0.2.3_2022-01-12_sample_input.mp4>
+
 
-Installation
-════════════
+2 Installation
+══════════════
 
   Octans is released to CPAN, you can get it from there or install it
   from source. In any case, `zef' is required to install the
@@ -56,23 +79,23 @@ Installation
     branch.
 
 
-Release
-───────
+2.1 Release
+───────────
 
   1. Run `zef install octans'.
 
   Octans should be installed, try running `octans --version' to confirm.
 
 
-From Source
-───────────
+2.2 From Source
+───────────────
 
   You can either download the release archive generated by cgit/GitHub
   or clone the project if you have `git' installed.
 
 
-Without `git'
-╌╌╌╌╌╌╌╌╌╌╌╌╌
+2.2.1 Without `git'
+╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
 
   1. Download the release:
      • <https://git.tilde.institute/andinus/octans>
@@ -81,8 +104,8 @@ Without `git'
   3. Run `zef install .' in source directory.
 
 
-With `git'
-╌╌╌╌╌╌╌╌╌╌
+2.2.2 With `git'
+╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
 
   All commits will be signed by my [PGP Key].
 
@@ -100,11 +123,11 @@ With `git'
 <https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc>
 
 
-Documentation
-═════════════
+3 Documentation
+═══════════════
 
-Implementation
-──────────────
+3.1 Implementation
+──────────────────
 
   Initially it went over the list of words & checked if they exist in
   the grid. This was very slow.
@@ -124,25 +147,31 @@ Implementation
   from my AoC (Advent of Code) 2020's day-11 solution.
 
 
-Options
-───────
+3.2 Options
+───────────
 
-dict
-╌╌╌╌
+3.2.1 dict
+╌╌╌╌╌╌╌╌╌╌
 
   Octans's default dictionary file is `/usr/share/dict/words', use
   `--dict' flag to change the dictionary. The words in dictionary must
   be seperated by a newline (`\n') & sorted alphabetically.
 
 
-length
-╌╌╌╌╌╌
+3.2.2 visualize
+╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
+
+  Generates a video solution for the puzzle.
+
+
+3.2.3 length
+╌╌╌╌╌╌╌╌╌╌╌╌
 
   Minimum word length to look for. Default is 7.
 
 
-path
-╌╌╌╌
+3.2.4 path
+╌╌╌╌╌╌╌╌╌╌
 
   The path to be passed must be a *readable file* or an *url* in either
   format:
@@ -154,17 +183,26 @@ path
     <https://mastodon.art/@Algot/105333136907848390>
 
 
-verbose
-╌╌╌╌╌╌╌
+3.2.5 verbose
+╌╌╌╌╌╌╌╌╌╌╌╌╌
 
   This will increase verbosity.
 
 
-News
-════
+4 News
+══════
+
+4.1 v0.2.3 - 2022-01-12
+───────────────────────
+
+  ⁃ Add visualize option.
+
+    `--visualize' now generates a video solution for the puzzle using
+    Cairo and ffmpeg.
+
 
-v0.2.0 - 2021-03-04
-───────────────────
+4.2 v0.2.0 - 2021-03-04
+───────────────────────
 
   ⁃ Removed `sample' option
 
@@ -193,8 +231,8 @@ v0.2.0 - 2021-03-04
           reset for each starting position.
 
 
-v0.1.4 - 2021-02-19
-───────────────────
+4.3 v0.1.4 - 2021-02-19
+───────────────────────
 
   ⁃ Fixed the puzzle parsing regex
 
@@ -202,26 +240,26 @@ v0.1.4 - 2021-02-19
     <https://mastodon.art/@Algot/105690195742318751>.
 
 
-v0.1.3 - 2021-01-24
-───────────────────
+4.4 v0.1.3 - 2021-01-24
+───────────────────────
 
   ⁃ Added an option to specify minimum word length.
 
 
-v0.1.2 - 2021-01-20
-───────────────────
+4.5 v0.1.2 - 2021-01-20
+───────────────────────
 
   ⁃ Input puzzle can now be of any size & not restricted to 4x4 grid.
 
 
-v0.1.1 - 2021-01-20
-───────────────────
+4.6 v0.1.1 - 2021-01-20
+───────────────────────
 
   ⁃ Read puzzle from a file.
 
 
-v0.1.0 - 2021-01-19
-───────────────────
+4.7 v0.1.0 - 2021-01-19
+───────────────────────
 
   ⁃ Improved performance by using a better algorithm to find words in
     the grid.