Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

Commit

Permalink
docs: update README to include links to user guides
Browse files Browse the repository at this point in the history
Added links to the installation guides, as well as a
pointer to the kata containers architecutre document.

Fixes: #315

Signed-off-by: Eric Ernst <[email protected]>
  • Loading branch information
Eric Ernst committed May 17, 2018
1 parent 32c734e commit b9c9ad9
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,21 @@ $ 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
See the
[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
The runtime uses a TOML format configuration file called `configuration.toml`.
Expand Down

0 comments on commit b9c9ad9

Please sign in to comment.