1 files changed, 68 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..d6b3cec
--- /dev/null
+++ b/README.org
@@ -0,0 +1,68 @@
+#+title: Antlia
+#+subtitle: Antlia is a text based Rock paper scissors game
+#+export_file_name: index
+#+setupfile: ~/.emacs.d/org-templates/projects.org
+
+| Website         | https://andinus.nand.sh/antlia             |
+| Source          | https://git.tilde.institute/andinus/antlia |
+| GitHub (mirror) | https://github.com/andinus/antlia          |
+
+* Installation
+
+Antlia 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 Antlia without ~zef~. Just run ~raku -Ilib bin/antlia~ from
+within the source directory.
+
+** Release
+
+1. Run ~zef install antlia~.
+
+Antlia should be installed, try running ~antlia --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/antlia
+   - https://github.com/andinus/antlia/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/antlia
+cd antlia
+
+# Install octans.
+zef install .
+#+end_src
+
+* 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 2.
+Support for more than 2 players will be added later.
+
+* News
+
+** v0.1.0 - 2021-04-29
+
+Initial Implementation