Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

How to install Andromeda

Andromeda is implemented in OCaml and relies on the OPAM package manager for installation. Please make sure you have a recent working OCaml & OPAM.

Execute the following command to get and install Andromeda:

opam pin add andromeda git+https://github.com/Andromedans/andromeda

How to compile Andromeda

If you would like to compile Andromeda yourself, follow these instructions.

Prerequisites

You need OCaml 4.12 or later, and quite possibly it works with earlier versions, and several OCaml packages, which you can install by running

opam install dune dune-build-info dune-site menhir sedlex

For line-editing in the interactive toplevel, install rlwrap (or ledit) and wrap the invocation yourself: rlwrap ./andromeda.exe.

Compilation

Checkout the Andromeda repository

git clone git@github.com:Andromedans/andromeda.git

or consider forking it if you intend to experiment with it, or contribute to the project.

To build Andromeda, run the command

dune build

in the andromeda folder. This will create the executable ./andromeda.exe. You can also run tests with

dune runtest

If you see no input, the tests passed.

Usage

You may run the compiled executable andromeda.exe. For basic usage and command-line options, run

./andromeda.exe --help