diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 40 |
1 files changed, 40 insertions, 0 deletions
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 |