aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2021-04-27 21:52:23 +0530
committerAndinus <andinus@nand.sh>2021-04-27 21:52:23 +0530
commit6832a0ffe038527c9c97dd38918c643f7748407a (patch)
tree45bb070396b262fd50eea29f8ce55475052460f3
parent4b8db3661bf9bac752f099f99577dd836c53fd0d (diff)
downloadcaelum-6832a0ffe038527c9c97dd38918c643f7748407a.tar.gz
Add install instructions, generate plain text READMEv0.1.0
-rw-r--r--README109
-rw-r--r--README.org40
2 files changed, 149 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..d035638
--- /dev/null
+++ b/README
@@ -0,0 +1,109 @@
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+ CAELUM
+ Caelum is a text based Cee-lo game
+
+ Andinus
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+
+Table of Contents
+─────────────────
+
+Installation
+Documentation
+News
+
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+ Website <https://andinus.nand.sh/caelum>
+ Source <https://git.tilde.institute/andinus/caelum>
+ GitHub (mirror) <https://github.com/andinus/caelum>
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+
+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/wik/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.0 - 2021-04-27
+───────────────────
+
+ Initial implementation.
diff --git a/README.org b/README.org
index c529c57..409591b 100644
--- a/README.org
+++ b/README.org
@@ -7,6 +7,46 @@
| Source | https://git.tilde.institute/andinus/caelum |
| GitHub (mirror) | https://github.com/andinus/caelum |
+* 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 [[https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc][PGP Key]].
+
+#+begin_src sh
+# Clone the project.
+git clone https://git.tilde.institute/andinus/caelum
+cd caelum
+
+# Install octans.
+zef install .
+#+end_src
+
* Documentation
** Implementation