Skip to content

Commit 5d91f6b

Browse files
committed
README: Add a table of contents
Linking the files from Makefile's DOC_FILES in their listed order. Link text generally follows the headers used by the linked document. Informative stuff (for image and implementation authors) is indented under the README (although I'm not sure there's consensus on whether media-types.md is normative or informative [1]). [1]: #304 (comment) Subject: manifest: List media types supported by descriptor references Signed-off-by: W. Trevor King <[email protected]>
1 parent d138321 commit 5d91f6b

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
The OCI Image Format project creates and maintains the software shipping container image format spec (OCI Image Format). The goal of this specification is to enable the creation of interoperable tools for building, transporting, and preparing a container image to run.
44

5+
## Table of Contents
6+
7+
- [Introduction](README.md)
8+
- [Code of Conduct](#code-of-conduct)
9+
- [Project Documentation](project.md)
10+
- [Media Types](media-types.md)
11+
- [Content Descriptors](descriptor.md)
12+
- [Image Layout](image-layout.md)
13+
- [Filesystem Layers](layer.md)
14+
- [Image Configuration](config.md)
15+
- [Manifests and Manifest Lists](manifest.md)
16+
17+
## Overview
18+
519
This specification defines how to create an OCI Image, which will generally be done by a build system, and output an [image manifest](manifest.md), a set of [filesystem layers](layer.md), and an [image configuration](config.md).
620
At a high level the image manifest contains metadata about the contents and dependencies of the image including the content-addressable identity of one or more [filesystem layer changeset](layer.md) archives that will be unpacked to make up the final runnable filesystem.
721
The image configuration includes information such as application arguments, environments, etc.

0 commit comments

Comments
 (0)