This repository

This repository includes:

• a command-line tool to create and deploy applications with MirageOS; and
• in types/, a library of type signatures that compliant applications use.

There are several diverse backends in MirageOS that require rather specialised build steps (from Xen to KVM unikernels), and this complexity is wrapped up in the tool.

To work with mirage, you'll need to either install prerequisites locally.

Local install

You will need the following:

• a working OCaml compiler (4.05.0 or higher).
• the OPAM source package manager (2.0.0 or higher).
• an x86_64 or armel Linux host to compile Xen kernels, or FreeBSD, OpenBSD or MacOS X for the solo5 and userlevel versions.

Using mirage

There are two stages to using mirage:

• a configure phase where necessary code is generated and dependencies are determined.
• an optional depends phase where OPAM package dependencies are satisfied.
• a build phase where the compiler and any support scripts are run.

You can find documentation, walkthroughs and tutorials over on the MirageOS website. The install instructions are a good place to begin!