Documentation for the Brane framework

Repository that contains the high-level documentation of the Brane framework. Written for use with mdBook.

This repository contains two sets of the documentations: a User Guide for Brane (./user-guide) and a kind of Specification for Brane (./specification). The first documentation, the User Guide, is aimed at the end-users of Brane, and details how to use the framework for its intended use. The second documentation, the Specification, is aimed at developers of the framework, and discusses the inner workings of the framework.

To visit the generated / released version of the framework, see https://wiki.enablingpersonalizedinterventions.nl/user-guide for the User Guide and https://wiki.enablingpersonalizedinterventions.nl/specification for the Specification.

Installation

Note that, to compile the documentation, you should have mdbook installed. It's available as a Cargo crate, so if you have Cargo installed, you can simply run:

$ cargo install mdbook

Then, you can compile the desired book by running:

# Go into the correct directory first
$ cd <book_dir>

# Build using mdbook
$ mdbook build

Alternatively, you can use the provided Make file to compile the various books, or the documentation as a whole.

$ make all # To build the entire documentation

$ make build/user-guide # To build user-guide
$ make build/specification # To build specification
$ make build/tutorials # To build tutorials

Note that this does not compile the code documentation as it will have to fetch the Brane source code and compile the documentation, which is almost always excessive. It is recommeneded that one compiles the documentation instead when developing the relevant parts of Brane.