Added README for uhyve-interface

hermit-os · Sep 19, 2024 · 10bf5b3 · 10bf5b3
1 parent 4ed8b02
commit 10bf5b3
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/uhyve-interface/README.md b/uhyve-interface/README.md
@@ -0,0 +1,7 @@
+<img width="200" align="right" src="https://raw.githubusercontent.com/hermit-os/uhyve/f4070692729c5f1fa1dbf6df67004acbfef39104/img/uhyve.svg" />
+
+# 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
@@ -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)]