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

24 lines
1.4 KiB
Markdown
Raw Normal View History

Fix remaining Chrome/Chromium OS instances These should be written as ChromeOS and ChromiumOS (without the space) to match the updated branding. The copyright headers were already migrated to the new style (https://crrev.com/c/3894243), but there were some more instances left over. BUG=None TEST=tools/cargo-doc Change-Id: I8c76aea2eb33b2e370ab71ee9b5cc0a4cfd00585 Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4129934 Reviewed-by: Dennis Kempin <denniskempin@google.com> Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
2022-12-29 21:24:33 +00:00
# crosvm - The ChromeOS 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
Fix remaining Chrome/Chromium OS instances These should be written as ChromeOS and ChromiumOS (without the space) to match the updated branding. The copyright headers were already migrated to the new style (https://crrev.com/c/3894243), but there were some more instances left over. BUG=None TEST=tools/cargo-doc Change-Id: I8c76aea2eb33b2e370ab71ee9b5cc0a4cfd00585 Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4129934 Reviewed-by: Dennis Kempin <denniskempin@google.com> Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
2022-12-29 21:24:33 +00:00
boundary for running native applications on the ChromeOS platform. Compared to QEMU, crosvm doesn’t
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
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
Fix remaining Chrome/Chromium OS instances These should be written as ChromeOS and ChromiumOS (without the space) to match the updated branding. The copyright headers were already migrated to the new style (https://crrev.com/c/3894243), but there were some more instances left over. BUG=None TEST=tools/cargo-doc Change-Id: I8c76aea2eb33b2e370ab71ee9b5cc0a4cfd00585 Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4129934 Reviewed-by: Dennis Kempin <denniskempin@google.com> Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
2022-12-29 21:24:33 +00:00
crosvm is currently used to run Linux/Android guests on ChromeOS devices.
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: 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
- [Documentation](https://crosvm.dev/book/)
Add new email lists to README.md and book BUG=b:234519125 TEST=None Change-Id: I8b4bed949fc66c87c5f2bf388b3d618b055244a7 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3698994 Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com> Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
2022-06-10 20:53:24 +00:00
- [Announcements](https://groups.google.com/a/chromium.org/g/crosvm-announce)
- [Developer Mailing List](https://groups.google.com/a/chromium.org/g/crosvm-dev)
- [#crosvm on matrix.org](https://matrix.to/#/#crosvm:matrix.org)
Switch main crosvm repo This updates all references to chromiumos/platform/crosvm to crosvm/crosvm. It will also switch ./tools/cl to upload to the new main repository. BUG=None TEST=None Change-Id: I1f71e5d5de2300e57ace1315cb4553f68533d576 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3760903 Reviewed-by: Daniel Verkamp <dverkamp@chromium.org> Tested-by: Dennis Kempin <denniskempin@google.com>
2022-07-13 17:49:40 +00:00
- [Source code](https://chromium.googlesource.com/crosvm/crosvm/)
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
- [API doc](https://crosvm.dev/doc/crosvm/), useful for searching API.
- For contribution, see [the contributor guide](https://crosvm.dev/book/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: Replace crbug link with issuetracker.google.com BUG=none TEST=./tools/fmt Change-Id: If7a252615f81530df026c5b2659457d4e8ec6be6 Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/3960212 Reviewed-by: Dmitry Torokhov <dtor@chromium.org> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
2022-10-18 00:49:24 +00:00
- [Public issue tracker](https://issuetracker.google.com/issues?q=status:open%20componentid:1161302)
- For Googlers: See [go/crosvm#filing-bugs](https://goto.google.com/crosvm#filing-bugs).
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