The following commands have to be run from the libraries root directory. To build the library, run
cargo buildThe output files will be created in the target/debug subdirectory.
To run tests, do:
cargo test -F testA documentation of all the public functions and structs will be built and opened in the browser using
cargo doc --no-deps --openThe files can also be found in the target/doc subdirectory.
To build a high-level md-book documentation, the mdbook and plantuml binaries are required. These can be installed using cargo:
cargo install mdbook
cargo install mdbook-plantuml --no-default-features --features plantuml-ssl-serverThe md-book can be created and opened by doing
cd documentation
mdbook serve --openThe book files will then be located in the documentation/book subdirectory.