Updating this Guide

We gladly welcome PRs that improve the quality of the OpenVMM guide!

The OpenVMM Guide is written in Markdown, and rendered to HTML using mdbook. You can find the source-code of this Guide in the main OpenVMM GitHub repo, in the Guide/ folder.

For small changes, you can simply click the "Suggest an Edit" button in the top-right corner of any page to automatically open up a GitHub Edit page.

For larger changes, we suggest cloning the repo locally, and previewing changes to Markdown in your editor (Visual Studio Code has good support for this).

Building locally

If you want a full rendered copy of the guide locally, you can build one by installing mdbook:

cargo install mdbook

Then from the root directory of the repo, running:

mdbook serve Guide

And navigating to the localhost URL in your web browser (typically http://127.0.0.1:3000/)