github/kata-containers
1
0
Fork 2
mirror of https://github.com/kata-containers/kata-containers.git synced 2026-03-18 10:44:10 +00:00
Code Issues Projects Releases Wiki Activity

docs: Add missing docs

Browse Source 
Add a few minimal documents to allow all the documentation in this
repository to be navigated from the top-level README.

Fixes #1681.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt
2019-05-15 16:21:34 +01:00
parent 1563263c0d
commit da2749c44d
5 changed files with 36 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
pkg/README.md Normal file
View File

@@ -0,0 +1,10 @@
# Kata golang packages
This repository contains a number of packages in addition to the
[`virtcontainers`](../virtcontainers) package:
| Package name | Description |
|-|-|
| [`katatestutils`](katatestutils) | Unit test utilities. |
| [`katautils`](katautils) | Utilities. |
| [`signals`](signals) | Signal handling functions. |

4
pkg/katautils/README.md Normal file
View File

@@ -0,0 +1,4 @@
# Kata utilities packages
The `katautils` package contains useful functions that are shared by various
parts of the codebase, including the runtime and the container v2 shim.

4
pkg/signals/README.md Normal file
View File

@@ -0,0 +1,4 @@
# Signals package
The `signals` package contains common signal handling functions that are shared by
the binaries built in this repository.