# Eden-sim - User Guide

## Introduction
This folder contains the user guide for the simulation library. The documentation can be accessed using a browser via book/index.html. 

## Prerequisites
The user guide can be read without any prerequisites other than a browser to read the book/index.html

To build the book, a rust and mdbook installation is required. See [rust installation guide](https://rust-lang.github.io/rustup/installation/index.html) and [mdbook installation guide](https://rust-lang.github.io/mdBook/guide/installation.html).

## Usage
To build the book :
```console
mdbook build
```

To serve the book :
```console
mdbook serve --open
```