about summary refs log blame commit diff stats
path: root/README
blob: 7cbbb65c53992f564f068e2d149091c25f7de4a2 (plain) (tree)









































































































                                                                                                                                                                                                
                ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                LACERTA
                 Lacerta parses WhatsApp exported logs

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


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

Installation
Documentation
News


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 Website          <https://andinus.nand.sh/lacerta>
 Source           <https://git.tilde.institute/andinus/lacerta>
 GitHub (mirror)  <https://github.com/andinus/lacerta>
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


Installation
════════════

  Lacerta is released to `fez', you can get it from there or install it
  from source. In any case, `zef' is required to install the
  distribution.

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


Release
───────

  1. Run `zef install lacerta'.

  Lacerta should be installed, try running `lacerta --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/lacerta>
     • <https://github.com/andinus/lacerta/releases>
  2. Extract the file.
  3. Run `zef install .' in source directory.


With `git'
╌╌╌╌╌╌╌╌╌╌

  All commits will be signed by my [PGP Key].

  ┌────
  │ # Clone the project.
  │ git clone https://git.tilde.institute/andinus/lacerta
  │ cd lacerta
  │
  │ # Install lacerta.
  │ zef install .
  └────


[PGP Key]
<https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc>


Documentation
═════════════

Implementation
──────────────

  Just enter the player names & it'll print each throw along with
  scores. Press enter to play another round.


Options
───────

players
╌╌╌╌╌╌╌

  Number of players. Default is 2, should be an integer equal to or
  greater than 2.


News
════

v0.1.0 - 2021-07-29
───────────────────

  Initial Implementation.