From 588a92da6c8d9982701e17f5f973d3944ffa8d11 Mon Sep 17 00:00:00 2001 From: Jonathan Klimt Date: Thu, 19 Sep 2024 10:17:55 +0200 Subject: [PATCH] Added README for uhyve-interface --- uhyve-interface/README.md | 7 +++++++ uhyve-interface/src/lib.rs | 11 ++++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 uhyve-interface/README.md diff --git a/uhyve-interface/README.md b/uhyve-interface/README.md new file mode 100644 index 00000000..3d2ebebf --- /dev/null +++ b/uhyve-interface/README.md @@ -0,0 +1,7 @@ + + +# Uhyve Hypercall Interface +[![crates.io](https://img.shields.io/crates/v/uhyve.svg)](https://crates.io/crates/uhyve) + +This crate specifies the interface between the [Hermit Unikernel](https://github.com/hermit-os/kernel) and the hypervisor [Uhyve](https://github.com/hermit-os/uhyve). +It includes the definition of the hypercalls and hypercall parameters and is intended to be used in both projects to ensure a coherent and well defined interface. diff --git a/uhyve-interface/src/lib.rs b/uhyve-interface/src/lib.rs index 0100f78b..e03445dd 100644 --- a/uhyve-interface/src/lib.rs +++ b/uhyve-interface/src/lib.rs @@ -1,4 +1,13 @@ -//! # Uhyve Hypervisor Interface +#![doc( + html_favicon_url = "https://media.githubusercontent.com/media/hermit-os/uhyve/main/img/uhyve_128.png" +)] +#![doc( + html_logo_url = "https://media.githubusercontent.com/media/hermit-os/uhyve/main/img/uhyve_512.png" +)] +//! # Uhyve Hypercall Interface +//! +//! This crate specifies the interface between the [Hermit Unikernel](https://github.com/hermit-os/kernel) and the hypervisor [Uhyve](https://github.com/hermit-os/uhyve). +//! It includes the definition of the hypercalls and hypercall parameters and is intended to be used in both projects to ensure a coherent and well defined interface. #![cfg_attr(not(feature = "std"), no_std)]