github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-31 16:36:38 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #316 from kata-containers/readme-updates

Browse Source 
docs: update README to include links to user guides
This commit is contained in:
Eric Ernst
2018-05-17 17:12:50 -07:00
committed by GitHub
parent d0c17a8206 b9c9ad94cf
commit 207ceaba8b
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`.