doc

OpenFairDB Development Documentation

Installation

Make sure

• Rust,
• PlantUML and
• Graphviz

are installed on your system.

Then you can install mdBook:

cargo install mdbook
cargo install mdbook-plantuml

Usage

The environment variable RELATIVE_INCLUDE has to be set to avoid fetching contents from C4-PlantUML on GitHub!

Build

RELATIVE_INCLUDE=. mdbook build

Serve interactively

RELATIVE_INCLUDE=. mdbook serve

For further information please look at the mdBook Documentation.