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://crosvm.dev/book/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.`

crosvm: update book and doc links to crosvm.dev Replaced using this script: git grep -l 'https://google.github.io/crosvm' \ \| xargs -n1 sed -i \ -e 's^https://google.github.io/crosvm/doc/^https://crosvm.dev/doc/^g' \ -e 's^https://google.github.io/crosvm/^https://crosvm.dev/book/^g' BUG=None TEST=mdbook build doc/book Change-Id: I8df4e0bcc1ca1e9044df29998572393c934e29cc Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/3795005 Commit-Queue: Daniel Verkamp <dverkamp@chromium.org> Reviewed-by: Dennis Kempin <denniskempin@google.com> Tested-by: Daniel Verkamp <dverkamp@chromium.org> 2022-07-29 22:05:14 +00:00			`See [Basic Usage](https://crosvm.dev/book/running_crosvm/example_usage.html) for a tutorial on how`
			`to run the examples.`