diff options
author | Andinus <andinus@nand.sh> | 2021-01-20 17:29:57 +0530 |
---|---|---|
committer | Andinus <andinus@nand.sh> | 2021-01-20 17:29:57 +0530 |
commit | 015b20808ece9320c97369504fde3c03e1e974a7 (patch) | |
tree | 3c50c1453c841533f44ffe888ca75dc63605b9e2 /README.org | |
parent | c78971d9bffb0ce05bab658b3ef3a9ece82ca7dd (diff) | |
download | octans-015b20808ece9320c97369504fde3c03e1e974a7.tar.gz |
Add install instructions to README
Diffstat (limited to 'README.org')
-rw-r--r-- | README.org | 40 |
1 files changed, 40 insertions, 0 deletions
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. |