From: Jan Kiszka <jan.kis...@siemens.com>

Signed-off-by: Jan Kiszka <jan.kis...@siemens.com>
---
 CONTRIBUTING.md |  6 ++++++
 README.md       | 27 +++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 CONTRIBUTING.md
 create mode 100644 README.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..80f1f52
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,6 @@
+The Jailhouse Images project uses the contribution process of its parent
+project Jailhouse. See
+
+    https://github.com/siemens/jailhouse/blob/master/CONTRIBUTING.md
+
+for details.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..42fd8c0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+Jailhouse Image
+===============
+
+The goal of this project is to generate ready-to-use reference images for the
+[Jailhouse hypervisor](https://github.com/siemens/jailhouse) to support
+demonstration and testing. The images are generated from Debian packages using
+the [Isar build system](https://github.com/ilbers/isar).
+
+
+Quickstart
+----------
+
+The host-side requirements are:
+
+- Docker (tested with 17.09.1-ce)
+- QEMU 2.7 (for x86 image)
+- Kernel >= 4.4 with KVM support (for x86 image)
+
+To build all images, just run ```build-images.sh```. A QEMU image can then be
+started using ```start-qemu.sh ARCHITECTURE```. Currently supported is "x86" as
+architecture.
+
+
+Community Resources
+-------------------
+
+See [Jailhouse project](https://github.com/siemens/jailhouse).
-- 
2.13.6

-- 
You received this message because you are subscribed to the Google Groups 
"Jailhouse" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to jailhouse-dev+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to