aljaz/kata-containers
1
0
Fork 0
mirror of https://github.com/aljazceru/kata-containers.git synced 2025-12-21 16:24:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README to include links to user guides

Browse Source 
Added links to the installation guides, as well as a
pointer to the kata containers architecutre document.

Fixes: #315

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
This commit is contained in:
Eric Ernst
2018-05-17 10:29:47 -07:00
parent 32c734e10b
commit b9c9ad94cf
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -65,11 +65,21 @@ $ kata-runtime kata-check
> $ sudo kata-runtime kata-check > $ sudo kata-runtime kata-check
> ``` > ```
## Quick start for users
See the [installation guides](https://github.com/kata-containers/documentation/tree/master/install/README.md)
available for various operating systems.
## Quick start for developers ## Quick start for developers
See the See the
[developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md). [developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md).
## Architecture overview
See the [architecture overview](https://github.com/kata-containers/documentation/blob/master/architecture.md)
for details on the Kata Containers design.
## Configuration ## Configuration
The runtime uses a TOML format configuration file called `configuration.toml`. The runtime uses a TOML format configuration file called `configuration.toml`.