Add user guide

This commit is contained in:
2026-03-10 11:03:11 +01:00
parent 58d494e674
commit d28adcf52d
51 changed files with 10408 additions and 1 deletions

20
userGuide/README.md Normal file
View File

@@ -0,0 +1,20 @@
# 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
```