INSTALL

           ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                              INSTALLATION
             Octans is a program to solve Algot's Wordplay
                          (Wordsearch) puzzles

                                Andinus
           ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


Table of Contents
─────────────────

1. Release
2. From Source


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.

You can run Octans without `zef'. Just run `raku -Ilib bin/octans' from
within the source directory.

• *Note*: Octans requires `WWW' module. You can however chose to not
  install it if you wish to run it locally. Checkout the `without-www'
  branch.


1 Release
═════════

  1. Run `zef install octans'.

  Octans should be installed, try running `octans --version' to confirm.


2 From Source
═════════════

  You can either download the release archive generated by cgit/GitHub
  or clone the project if you have `git' installed.


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 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>