Match-id-080f6ca948df8c7228aa4e7f2ff186c579ca37d1

hook/vendor/github.com/opencontainers/runtime-spec/schema/README.md

@@ -0,0 +1,48 @@
+# JSON schema
+
+## Overview
+
+This directory contains the [JSON Schema](http://json-schema.org/) for validating JSON covered by this specification.
+
+The layout of the files is as follows:
+
+* [config-schema.json](config-schema.json) - the primary entrypoint for the [configuration](../config.md) schema
+* [config-linux.json](config-linux.json) - the [Linux-specific configuration sub-structure](../config-linux.md)
+* [config-solaris.json](config-solaris.json) - the [Solaris-specific configuration sub-structure](../config-solaris.md)
+* [config-windows.json](config-windows.json) - the [Windows-specific configuration sub-structure](../config-windows.md)
+* [state-schema.json](state-schema.json) - the primary entrypoint for the [state JSON](../runtime.md#state) schema
+* [defs.json](defs.json) - definitions for general types
+* [defs-linux.json](defs-linux.json) - definitions for Linux-specific types
+* [defs-windows.json](defs-windows.json) - definitions for Windows-specific types
+* [validate.go](validate.go) - validation utility source code
+
+
+## Utility
+
+There is also included a simple utility for facilitating validation.
+To build it:
+
+```bash
+export GOPATH=`mktemp -d`
+go get -d ./...
+go build ./validate.go
+rm -rf $GOPATH
+```
+
+Or you can just use make command to create the utility:
+
+```bash
+make validate
+```
+
+Then use it like:
+
+```bash
+./validate config-schema.json <yourpath>/config.json
+```
+
+Or like:
+
+```bash
+./validate https://raw.githubusercontent.com/opencontainers/runtime-spec/v1.0.0/schema/schema.json <yourpath>/config.json
+```