diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 37 |
1 files changed, 0 insertions, 37 deletions
diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 6f847fa4b..000000000 --- a/docs/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# gVisor Documentation - -**This doc is a work in progress. For the definitive documentation please see -the [README](../README.md)** - -gVisor is a user-space kernel, written in Go, that implements a substantial -portion of the [Linux system call interface][linux-interface]. It provides an -additional layer of isolation between running applications and the host -operating system. - -gVisor includes an [Open Container Initiative (OCI)][oci] runtime called `runsc` -that makes it easy to work with existing container tooling. The `runsc` runtime -integrates with Docker and Kubernetes, making it simple to run sandboxed -containers. - -Check out the [gVisor Quick Start](user_guide/quick_start.md) to get started -using gVisor. - -gVisor takes a distinct approach to container sandboxing and makes a different -set of technical trade-offs compared to existing sandbox technologies, thus -providing new tools and ideas for the container security landscape. - -Check out [Why gVisor?](architecture_guide/why.md) for more on why we made -gVisor. - -## How this documentation is organized - -- The [Architecture Guide](architecture_guide/README.md) explains about - gVisor's architecture & design philosophy. Start here if you would like to - know more about how gVisor works and why it was created. -- The [User Guide](user_guide/README.md) contains info on how to use gVisor - and integrate it into your application or platform. -- The [Contributer Guide](contributer_guide/README.md) includes documentation - on how to build gVisor, run tests, and contribute to gVisor's development. - -[linux-interface]: https://en.wikipedia.org/wiki/Linux_kernel_interfaces -[oci]: https://www.opencontainers.org |