From a3afd525f0349b1bfc88c448d1d6718188f16a2e Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 20 Dec 2017 18:00:43 +0000 Subject: [PATCH] doc: Add Users section with install details Add a new "Users" section with pointers off to installation details for Clear Containers and runV. Fixes #2. Signed-off-by: James O. D. Hunt --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index ccd96459b7..de53c53280 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ * [About Kata Containers](#about-kata-containers) * [Community](#community) + * [Users](#users) + * [Installing Clear Containers](#installing-clear-containers) + * [Installing runV](#installing-runv) * [Developers](#developers) * [Contributor](#contributor) * [Maintainer](#maintainer) @@ -21,6 +24,25 @@ Kata Containers combines technology from [Intel® Clear Containers](https://gith Kata Containers is working to build global, diverse and collaborative community. Anyone who is interested in supporting the technology is welcome to participate. We are seeking different expertise and skills, ranging from development, operations, documentation, marketing, community organization and product management. +## Users + +Since Kata Containers does not yet provide an installation option, the current +advice for users is to install either Clear Containers or runV since both +projects will provide a migration path to Kata Containers at a later date. + +If you do not already have an installation of either project, Clear Containers +may be the simplest option as packages for commont Linux* distributions are +provided. However, your choice may depend on the particular project features +that interest you. + +### Installing Clear Containers + +See https://github.com/clearcontainers/runtime/wiki/Installation. + +### Installing runV + +See https://github.com/hyperhq/runv. + ## Developers For code contributors, there are currently two roles relevant to project governance: