path: root/README

                  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                 CAELUM
                   Caelum is a text based Cee-lo game

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


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

Demo
Installation
Documentation
News


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


Demo
════

  This was recorded with `asciinema'.

  [https://asciinema.org/a/410291.png]

  ⁃ Caelum v0.1.1: <https://asciinema.org/a/410291>


[https://asciinema.org/a/410291.png] <https://asciinema.org/a/410291>


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

  Caelum 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 Caelum without `zef'. Just run `raku -Ilib bin/caelum'
  from within the source directory.


Release
───────

  1. Run `zef install caelum'.

  Caelum should be installed, try running `caelum --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/caelum>
     • <https://github.com/andinus/caelum/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/caelum
  │ cd caelum
  │
  │ # Install octans.
  │ zef install .
  └────


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


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

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

  Caelum is an implementation of [Cee-lo without a bank]. The bet amount
  is set to be the average of whatever each player decides.


[Cee-lo without a bank]
<https://en.wikipedia.org/wiki/Cee-lo#Cee-lo_without_a_bank_(winner_take_all)>


Options
───────

players
╌╌╌╌╌╌╌

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


News
════

v0.1.1 - 2021-04-27
───────────────────

  ⁃ Fixed bug in winning logic.


v0.1.0 - 2021-04-27
───────────────────

  Initial implementation.