diff options
| -rw-r--r-- | README | 88 | ||||
| -rw-r--r-- | README.org | 40 |
2 files changed, 121 insertions, 7 deletions
diff --git a/README b/README index 8910eee..e308a21 100644 --- a/README +++ b/README @@ -9,9 +9,15 @@ Table of Contents ───────────────── 1. Demo -2. Documentation +2. Installation +.. 1. Release +.. 2. From Source +3. Documentation .. 1. Implementation .. 2. Options +4. News +.. 1. v0.1.1 - 2020-01-20 +.. 2. v0.1.0 - 2020-01-19 Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles. @@ -39,10 +45,62 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles. [https://asciinema.org/a/385500.png] <https://asciinema.org/a/385500> -2 Documentation +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 + distribution. + + +2.1 Release +─────────── + + 1. Run `zef install octans'. + + Octans should be installed, try running `octans --version' to confirm. + + +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.tilde.institute/andinus/octans> + • <https://github.com/andinus/octans/releases> + 2. Extract the file. + 3. Run `zef install .' in source directory. + + +2.2.2 With `git' +╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌ + + All commits will be signed by my [PGP Key]. + + ┌──── + │ # Clone the project. + │ git clone https://git.tilde.institute/andinus/octans + │ cd octans + │ + │ # Install octans. + │ zef install . + └──── + + +[PGP Key] +<https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc> + + +3 Documentation ═══════════════ -2.1 Implementation +3.1 Implementation ────────────────── Initially it went over the list of words & checked if they exist in @@ -60,10 +118,10 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles. slower than previous implementation. -2.2 Options +3.2 Options ─────────── -2.2.1 dict +3.2.1 dict ╌╌╌╌╌╌╌╌╌╌ Octans's default dictionary file is `/usr/share/dict/words', use @@ -71,7 +129,7 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles. be seperated by a newline (`\n') & sorted alphabetically. -2.2.2 path +3.2.2 path ╌╌╌╌╌╌╌╌╌╌ The path to be passed must be a *readable file* or an *url* in either @@ -84,7 +142,23 @@ Octans is a program to solve Algot's Wordplay (Wordsearch) puzzles. <https://mastodon.art/@Algot/105333136907848390> -2.2.3 verbose +3.2.3 verbose ╌╌╌╌╌╌╌╌╌╌╌╌╌ This will increase verbosity. + + +4 News +══════ + +4.1 v0.1.1 - 2020-01-20 +─────────────────────── + + ⁃ Read puzzle from a file. + + +4.2 v0.1.0 - 2020-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 5847eb1..923a86c 100644 --- a/README.org +++ b/README.org @@ -21,6 +21,38 @@ This was recorded with =asciinema(1)=. + Octans 2020-01-14: https://asciinema.org/a/384464 + alt-link (download): https://andinus.nand.sh/static/octans +* 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. + +** Release +1. Run =zef install octans=. + +Octans should be installed, try running =octans --version= to confirm. + +** From Source +You can either download the release archive generated by cgit/GitHub or +clone the project if you have =git= installed. + +*** Without =git= +1. Download the release: + - https://git.tilde.institute/andinus/octans + - https://github.com/andinus/octans/releases +2. Extract the file. +3. Run =zef install .= in source directory. + +*** With =git= +All commits will be signed by my [[https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc][PGP Key]]. + +#+BEGIN_SRC sh +# Clone the project. +git clone https://git.tilde.institute/andinus/octans +cd octans + +# Install octans. +zef install . +#+END_SRC + * Documentation ** Implementation Initially it went over the list of words & checked if they exist in the @@ -55,3 +87,11 @@ format: *** verbose This will increase verbosity. + +* News +** v0.1.1 - 2020-01-20 ++ Read puzzle from a file. + +** v0.1.0 - 2020-01-19 +This version improved performance by re-implementing the algorithm to +find words in grid. |