diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 16 insertions, 3 deletions
@@ -11,10 +11,12 @@ Check the `README` in each directory for more information. ## Getting dependencies The easiest way to install the required dependencies is using Nix. -After [installing it](https://nixos.org/download/), simply run `nix develop`. -This environment includes everything necessary for building the program, visualisations, and thesis. +After [installing it](https://nixos.org/download/), simply run one of the two commands below: -You can also build the program itself with `nix build .#default`. + - `nix develop .#full` for a full environment with everything required to build the project, visualisations, and thesis. (approx 3.4G disk space) + - `nix develop .#minimal` for a smaller environment, with only enough to build the project and run tests (approx 1.9G disk space). + +You can also build the program itself with `nix build .#default`, or see below to run a test VM. Alternatively, manually set up the following programs: @@ -27,3 +29,14 @@ Alternatively, manually set up the following programs: - To build the thesis: - Texlive, with the packages listed in `nix/tex-env.nix` - `latexmk` + +Once you have dependencies installed, check the `README` in each directory for details on how to reproduce our results. + +## Building a testing VM + +The VM which we used for testing can be fully rebuilt by running `nix build .#vm`. This requires around 3.1G on disk. + +After building, run `./result/bin/run-candelabra-vm` to start it. +The credentials are `root` / `candelabra`, and you can use SSH if desired. + +The VM has candelabra prebuilt as `candelabra-cli`, but no tools for visualisation or building the thesis. |