From b92d2b9e0ac128cbd3f84e320a9b5b440a4cdb64 Mon Sep 17 00:00:00 2001 From: danbugs Date: Thu, 7 Nov 2024 18:56:48 +0000 Subject: [PATCH 1/2] [documentation] small README changes Signed-off-by: danbugs --- README.md | 10 +++++----- .../{hl-tentative-logo.png => hyperlight-logo.png} | Bin .../{hl-tentative-logo.xcf => hyperlight-logo.xcf} | Bin 3 files changed, 5 insertions(+), 5 deletions(-) rename docs/assets/{hl-tentative-logo.png => hyperlight-logo.png} (100%) rename docs/assets/{hl-tentative-logo.xcf => hyperlight-logo.xcf} (100%) diff --git a/README.md b/README.md index b84fec2c3..8a5e09d88 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -
+

Hyperlight

- + hyperlight logo

Hyperlight is a lightweight Virtual Machine Manager (VMM) designed to be embedded within applications. It enables safe execution of untrusted code within micro virtual machines with very low latency and minimal overhead. @@ -157,7 +157,7 @@ For examples of guest applications, see the [./src/tests/c_guests](./src/tests/c - [src/tests/c_guests](./src/tests/c_guests) - This directory contains two Hyperlight Guest programs written in C, which are intended to be launched within partitions as "guests". - Tests: - - [src/hyperlight-testing](./src/hyperlight_testing/) - Shared testing code for Hyperlight projects build int Rust. + - [src/hyperlight-testing](./src/hyperlight_testing) - Shared testing code for Hyperlight projects build int Rust. ## Try it yourself! @@ -220,9 +220,9 @@ If all worked as expected, you should the following message in your console: Hello, World! I am executing inside of a VM :) ``` -If you get the error `Error: NoHypervisorFound` and KVM or mshv is set up then this may be a permissions issue. In bash you can use `ls -l /dev/kvm` or `ls -l /dev/mshv` to check which groups that owns the device and then `groups` to make sure your user is a member of that group. +If you get the error `Error: NoHypervisorFound` and KVM or mshv is set up then this may be a permissions issue. In bash, you can use `ls -l /dev/kvm` or `ls -l /dev/mshv` to check which groups that owns the device and then `groups` to make sure your user is a member of that group. -For more details on how to verify that KVM is correctly installed and permissions are correct, follow the guide [here](https://help.ubuntu.com/community/KVM/Installation)). +For more details on how to verify that KVM is correctly installed and permissions are correct, follow the guide [here](https://help.ubuntu.com/community/KVM/Installation). ## Contributing to Hyperlight diff --git a/docs/assets/hl-tentative-logo.png b/docs/assets/hyperlight-logo.png similarity index 100% rename from docs/assets/hl-tentative-logo.png rename to docs/assets/hyperlight-logo.png diff --git a/docs/assets/hl-tentative-logo.xcf b/docs/assets/hyperlight-logo.xcf similarity index 100% rename from docs/assets/hl-tentative-logo.xcf rename to docs/assets/hyperlight-logo.xcf From 38639356fd5fdee893272bf765ef7e352775db20 Mon Sep 17 00:00:00 2001 From: Dan Chiarlone Date: Thu, 7 Nov 2024 12:30:09 -0800 Subject: [PATCH 2/2] Update README.md Co-authored-by: Simon Davies Signed-off-by: danbugs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a5e09d88..3a60b4cbe 100644 --- a/README.md +++ b/README.md @@ -220,7 +220,7 @@ If all worked as expected, you should the following message in your console: Hello, World! I am executing inside of a VM :) ``` -If you get the error `Error: NoHypervisorFound` and KVM or mshv is set up then this may be a permissions issue. In bash, you can use `ls -l /dev/kvm` or `ls -l /dev/mshv` to check which groups that owns the device and then `groups` to make sure your user is a member of that group. +If you get the error `Error: NoHypervisorFound` and KVM or mshv is set up then this may be a permissions issue. In bash, you can use `ls -l /dev/kvm` or `ls -l /dev/mshv` to check which group owns that device and then `groups` to make sure your user is a member of that group. For more details on how to verify that KVM is correctly installed and permissions are correct, follow the guide [here](https://help.ubuntu.com/community/KVM/Installation).