From 577fd9fcc0696db1d5adec45e3ec660e7fda98f5 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 16 May 2019 16:41:37 +0100 Subject: [PATCH] docs: Add missing READMEs Created a skeletal set of README for the packaging areas that didn't have them: - Jenkins - OBS - QEMU - static build tooling Signed-off-by: James O. D. Hunt --- Jenkinsfiles/README.md | 8 ++++++++ obs-packaging/README.md | 11 +++++++++++ qemu/README.md | 3 +++ static-build/README.md | 3 +++ 4 files changed, 25 insertions(+) create mode 100644 Jenkinsfiles/README.md create mode 100644 obs-packaging/README.md create mode 100644 qemu/README.md create mode 100644 static-build/README.md diff --git a/Jenkinsfiles/README.md b/Jenkinsfiles/README.md new file mode 100644 index 0000000000..6982baef56 --- /dev/null +++ b/Jenkinsfiles/README.md @@ -0,0 +1,8 @@ +# Jenkins + +Kata Containers uses [Jenkins](https://jenkins.io/) +for [its main CI](http://jenkins.katacontainers.io/). + +This directory contains support files for the Jenkins +[pipeline](https://jenkins.io/doc/book/pipeline/) +[plugin](https://wiki.jenkins.io/display/JENKINS/Pipeline+Plugin). diff --git a/obs-packaging/README.md b/obs-packaging/README.md new file mode 100644 index 0000000000..3a7eb116d5 --- /dev/null +++ b/obs-packaging/README.md @@ -0,0 +1,11 @@ +# Building under OBS + +SUSE's [Open Build Service (OBS)](https://openbuildservice.org) is used to +build [the official Kata Containers packages](https://build.opensuse.org/project/subprojects/home:katacontainers). + +This directory contains tooling and packaging metadata to build all Kata +components with OBS. + +See +[the Kata installation documentation](https://github.com/kata-containers/documentation/blob/master/install/README.md) +for instructions on how to install the official packages. diff --git a/qemu/README.md b/qemu/README.md new file mode 100644 index 0000000000..d900b5143a --- /dev/null +++ b/qemu/README.md @@ -0,0 +1,3 @@ +# QEMU patches + +This directory contains patches used to build QEMU. diff --git a/static-build/README.md b/static-build/README.md new file mode 100644 index 0000000000..70f3014e8a --- /dev/null +++ b/static-build/README.md @@ -0,0 +1,3 @@ +# Static build + +This directory contains files to build static versions of Kata Containers.