crosvm/tools/examples/README.md

# Crosvm on Linux Example

This directory contains an examples for how to run a VM with crosvm on linux.

See [Basic Usage](https://google.github.io/crosvm/running_crosvm/example_usage.html) for a tutorial
on how to run the examples.
Add functional crosvm examples for running on linux Two examples are added. A simple one and one with network configured. The examples are written in a way they can be integrated with the mdbook to form a tutorial. This will ensure the tutorial code snippets stay up to date. The documentation for networking is added after https://crrev.com/c/3237468 is merged. BUG=b:214104901 TEST=./tools/examples/example_simple Change-Id: I33682878858d8a0324fbb6a87e33cd55b29811b7 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3388063 Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Commit-Queue: Dennis Kempin <denniskempin@google.com> Tested-by: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> 2022-01-13 22:05:32 +00:00			`# Crosvm on Linux Example`

			`This directory contains an examples for how to run a VM with crosvm on linux.`

Reorganize usage doc and add example usage BUG=b:214104901 TEST=mdbook serve Change-Id: I7039493212912cb698f74967abef228df278f4c7 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3399872 Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com> 2022-01-21 19:07:58 +00:00			`See [Basic Usage](https://google.github.io/crosvm/running_crosvm/example_usage.html) for a tutorial`
			`on how to run the examples.`