From 26012df46743446adc2dc2ee3d7bc15917f6c9da Mon Sep 17 00:00:00 2001 From: Jess Valarezo Date: Mon, 4 Dec 2017 17:59:07 -0800 Subject: [PATCH] add table of contents to readme Signed-off-by: Jess Valarezo --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 55adf0e6a..4163191c6 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,23 @@ containerd is designed to be embedded into a larger system, rather than being us ## Getting Started -If you are interested in trying out containerd please see our [Getting Started Guide](docs/getting-started.md). +See our documentation on [containerd.io](containerd.io): +* [for ops and admins](docs/ops.md) +* [namespaces](docs/namespaces.md) +* [client options](docs/client-opts.md) + +See how to build containerd from source at [BUILDING](BUILDING.md). + +If you are interested in trying out containerd see our example at [Getting Started](docs/getting-started.md). + ## Runtime Requirements Runtime requirements for containerd are very minimal. Most interactions with the Linux and Windows container feature sets are handled via [runc](https://github.com/opencontainers/runc) and/or -OS-specific libraries (e.g. [hcsshim](https://github.com/Microsoft/hcsshim) for Microsoft). There are specific features +OS-specific libraries (e.g. [hcsshim](https://github.com/Microsoft/hcsshim) for Microsoft). The current required version of runc is always listed in [RUNC.md](/RUNC.md). + +There are specific features used by containerd core code and snapshotters that will require a minimum kernel version on Linux. With the understood caveat of distro kernel versioning, a reasonable starting point for Linux is a minimum 4.x kernel version. @@ -33,8 +43,6 @@ distribution. To use Linux checkpoint and restore features, you will need `criu` installed on your system. See more details in [Checkpoint and Restore](#checkpoint-and-restore). -The current required version of runc is always listed in [RUNC.md](/RUNC.md). - Build requirements for developers are listed in the [Developer Quick-Start](#developer-quick-start) section. ## Features