mirrors/crosvm
1
0
Fork 0
mirror of https://chromium.googlesource.com/crosvm/crosvm synced 2024-11-24 12:34:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
crosvm/README.md

20 lines
1.1 KiB
Markdown
Raw Normal View History

add usage information to README TEST=None BUG=None Change-Id: Iab070c5788e19e63140643115af6e48421989f9b Reviewed-on: https://chromium-review.googlesource.com/683798 Commit-Ready: Zach Reizner <zachr@chromium.org> Tested-by: Zach Reizner <zachr@chromium.org> Reviewed-by: Jason Clinton <jclinton@chromium.org> Reviewed-by: Stephen Barber <smbarber@chromium.org>
2017-09-26 04:15:31 +00:00
# crosvm - The Chrome OS Virtual Machine Monitor
add LICENSE and README TEST=None BUG=None Change-Id: I78e61545c6db18ae37925d02f7b0d6538deb6275 Reviewed-on: https://chromium-review.googlesource.com/478458 Commit-Ready: Zach Reizner <zachr@chromium.org> Tested-by: Zach Reizner <zachr@chromium.org> Reviewed-by: Stephen Barber <smbarber@chromium.org> Reviewed-by: Dylan Reid <dgreid@chromium.org>
2017-04-14 23:54:03 +00:00
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
crosvm is a virtual machine monitor (VMM) based on Linux’s KVM hypervisor, with a focus on
simplicity, security, and speed. crosvm is intended to run Linux guests, originally as a security
boundary for running native applications on the Chrome OS platform. Compared to QEMU, crosvm doesn’t
emulate architectures or real hardware, instead concentrating on paravirtualized devices, such as
the virtio standard.
Simplify README Since we've already moved contents of README to mdbook, let's have only a simple description and a list of links in README. BUG=b:199874828 TEST=none Change-Id: I42213a0be915154309443cdd07493ef3c64842a1 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3159890 Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-09-14 15:16:50 +00:00
crosvm is currently used to run Linux/Android guests on Chrome OS devices.
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
- [Documentation](https://google.github.io/crosvm/)
- [Source code](https://chromium.googlesource.com/chromiumos/platform/crosvm/)
- [API doc](https://google.github.io/crosvm/doc/crosvm/), useful for searching API.
README: Update link to contributor guide https://crrev.com/c/3557813 moved /doc/book/src/contributing.md to /doc/book/scr/contributing/index.md The link needs to be updated as well. BUG=b:227345067 TEST=curl -I https://google.github.io/crosvm/contributing/ shows HTTP/2 200 Change-Id: I6f659fde2d03da573f63cc656d95d24a253138b0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3640903 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Chih-Yang Hsia <paulhsia@chromium.org> Commit-Queue: Chih-Yang Hsia <paulhsia@chromium.org>
2022-05-11 09:10:46 +00:00
- For contribution, see [the contributor guide](https://google.github.io/crosvm/contributing/).
Mirror repository is available at [GitHub](https://github.com/google/crosvm) for your
convenience, but we don't accept bug reports or pull requests there.
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
- [Issue tracker](https://bugs.chromium.org/p/chromium/issues/list?q=component:OS%3ESystems%3EContainers)
README: Use PNG logo image Use PNG instead of SVG as Gitiles doesn't render SVG well. In order to make ImageMagick's conversion work well, fill-opacity and stroke-opacity are explicitly specified in the SVG. Also, the PNG image will be put at the bottom of README so people can read contents at first glance without scrolling over the logo. BUG=none TEST=check gitiles view on Gerrit TEST=mdbook build Change-Id: I2203be1258265400be3caf2ad8d8a1e8cacc5aab Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3250151 Tested-by: kokoro <noreply+kokoro@google.com> Reviewed-by: Dennis Kempin <denniskempin@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
2021-10-28 09:35:55 +00:00
![Logo](./logo/logo_512.png)
Reference in a new issue Copy permalink