Remove section numbers from README, document length option

2 files changed, 55 insertions, 48 deletions

diff --git a/README b/README
index 3ccc282..acfb13a 100644
--- a/README
+++ b/README
@@ -8,18 +8,18 @@
 Table of Contents
 ─────────────────
 
-1. Demo
-2. Installation
-.. 1. Release
-.. 2. From Source
-3. Documentation
-.. 1. Implementation
-.. 2. Options
-4. News
-.. 1. v0.1.3 - 2021-01-24
-.. 2. v0.1.2 - 2021-01-20
-.. 3. v0.1.1 - 2021-01-20
-.. 4. v0.1.0 - 2021-01-19
+Demo
+Installation
+.. Release
+.. From Source
+Documentation
+.. Implementation
+.. Options
+News
+.. v0.1.3 - 2021-01-24
+.. v0.1.2 - 2021-01-20
+.. v0.1.1 - 2021-01-20
+.. v0.1.0 - 2021-01-19
 
 
 Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles.
@@ -29,8 +29,8 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles.
 • GitHub: <https://github.com/andinus/octans>
 
 
-1 Demo
-══════
+Demo
+════
 
   This was recorded with `asciinema(1)'.
 
@@ -47,31 +47,31 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles.
 [https://asciinema.org/a/385500.png] <https://asciinema.org/a/385500>
 
 
-2 Installation
-══════════════
+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
   distribution.
 
 
-2.1 Release
-───────────
+Release
+───────
 
   1. Run `zef install octans'.
 
   Octans should be installed, try running `octans --version' to confirm.
 
 
-2.2 From Source
-───────────────
+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'
-╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
+Without `git'
+╌╌╌╌╌╌╌╌╌╌╌╌╌
 
   1. Download the release:
      • <https://git.tilde.institute/andinus/octans>
@@ -80,8 +80,8 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles.
   3. Run `zef install .' in source directory.
 
 
-2.2.2 With `git'
-╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
+With `git'
+╌╌╌╌╌╌╌╌╌╌
 
   All commits will be signed by my [PGP Key].
 
@@ -99,11 +99,11 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles.
 <https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc>
 
 
-3 Documentation
-═══════════════
+Documentation
+═════════════
 
-3.1 Implementation
-──────────────────
+Implementation
+──────────────
 
   Initially it went over the list of words & checked if they exist in
   the grid. This was very slow.
@@ -120,19 +120,25 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles.
   slower than previous implementation.
 
 
-3.2 Options
-───────────
+Options
+───────
 
-3.2.1 dict
-╌╌╌╌╌╌╌╌╌╌
+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.
 
 
-3.2.2 path
-╌╌╌╌╌╌╌╌╌╌
+length
+╌╌╌╌╌╌
+
+  Minimum word length to look for. Default is 7.
+
+
+path
+╌╌╌╌
 
   The path to be passed must be a *readable file* or an *url* in either
   format:
@@ -144,35 +150,35 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles.
     <https://mastodon.art/@Algot/105333136907848390>
 
 
-3.2.3 verbose
-╌╌╌╌╌╌╌╌╌╌╌╌╌
+verbose
+╌╌╌╌╌╌╌
 
   This will increase verbosity.
 
 
-4 News
-══════
+News
+════
 
-4.1 v0.1.3 - 2021-01-24
-───────────────────────
+v0.1.3 - 2021-01-24
+───────────────────
 
   ⁃ Added an option to specify minimum word length.
 
 
-4.2 v0.1.2 - 2021-01-20
-───────────────────────
+v0.1.2 - 2021-01-20
+───────────────────
 
   ⁃ Input puzzle can now be of any size & not restricted to 4x4 grid.
 
 
-4.3 v0.1.1 - 2021-01-20
-───────────────────────
+v0.1.1 - 2021-01-20
+───────────────────
 
   ⁃ Read puzzle from a file.
 
 
-4.4 v0.1.0 - 2021-01-19
-───────────────────────
+v0.1.0 - 2021-01-19
+───────────────────
 
   This version improved performance by re-implementing the algorithm to
   find words in grid.
diff --git a/README.org b/README.org
index 402b7f1..6f046f0 100644
--- a/README.org
+++ b/README.org
@@ -1,6 +1,6 @@
 #+SETUPFILE: ~/.emacs.d/org-templates/projects.org
 #+EXPORT_FILE_NAME: index
-#+OPTIONS: toc:2
+#+OPTIONS: toc:2 num:nil
 #+TITLE: Octans
 
 Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles.
@@ -74,7 +74,8 @@ than previous implementation.
 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
+Minimum word length to look for. Default is 7.
 *** path
 The path to be passed must be a *readable file* or an *url* in either
 format: