diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/README.org b/README.org index 98a58b7..df63385 100644 --- a/README.org +++ b/README.org @@ -18,6 +18,49 @@ Solution for /DFS-33/, generated on /2021-11-03/ (click to play). [[https://andinus.unfla.me/resources/projects/fornax/2021-11-03-DFS-33.mp4][https://andinus.unfla.me/resources/projects/fornax/2021-11-03-DFS-33.png]] +* Installation + +~fornax~ is written in Raku, it can be installed with ~zef~. You can also +run it without ~zef~, just run ~raku -Ilib bin/fornax~ from within the +source directory. + +- *Note*: ~Cairo~ module & ~ffmpeg~ program is required. + +** Release + +1. Run ~zef install fornax~. + +Fornax should be installed, try running ~fornax --version~ to confirm. + +- Solving programs / solutions are not included in the distribution, get + them from this repository. + +** 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.unfla.me/andinus/fornax + - https://github.com/andinus/fornax/releases +2. Extract the file. +3. Run ~zef install .~ in source directory. + +*** With ~git~ + +All commits by /Andinus/ will be signed by this [[https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc][PGP Key]]. + +#+begin_src sh +# Clone the project. +git clone https://git.tilde.institute/andinus/fornax +cd fornax + +# Install fornax. +zef install . +#+end_src + * Documentation Fornax parses /Fornax format/, generates a ~PNG~ for each iteration which is |