diff --git a/hack/CONTRIBUTORS.md b/CONTRIBUTORS_GUIDE.md similarity index 99% rename from hack/CONTRIBUTORS.md rename to CONTRIBUTORS_GUIDE.md index b7eba42a..917e2c96 100644 --- a/hack/CONTRIBUTORS.md +++ b/CONTRIBUTORS_GUIDE.md @@ -1,4 +1,4 @@ -# Contributing to libcontainer +# The libcontainer Contributors' Guide Want to hack on libcontainer? Awesome! Here are instructions to get you started. They are probably not perfect, please let us know if anything diff --git a/hack/MAINTAINERS.md b/MAINTAINERS_GUIDE.md similarity index 99% rename from hack/MAINTAINERS.md rename to MAINTAINERS_GUIDE.md index 4cc95fbb..3806ee6b 100644 --- a/hack/MAINTAINERS.md +++ b/MAINTAINERS_GUIDE.md @@ -1,4 +1,4 @@ -# The libcontainer Maintainer manual +# The libcontainer Maintainers' Guide ## Introduction diff --git a/hack/PRINCIPLES.md b/PRINCIPLES.md similarity index 100% rename from hack/PRINCIPLES.md rename to PRINCIPLES.md diff --git a/README.md b/README.md index f7f6760c..6ecafffc 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ ## libcontainer - reference implementation for containers -#### background +#### Background libcontainer specifies configuration options for what a container is. It provides a native Go implementation for using Linux namespaces with no external dependencies. libcontainer provides many convenience functions for working with namespaces, networking, and management. -#### container +#### Container A container is a self contained directory that is able to run one or more processes without affecting the host system. The directory is usually a full system tree. Inside the directory a `container.json` file is placed with the runtime configuration for how the processes @@ -35,8 +35,18 @@ If you wish to spawn another process inside the container while your current bas running just run the exact same command again to get another bash shell or change the command. If the original process dies, PID 1, all other processes spawned inside the container will also be killed and the namespace will be removed. You can identify if a process is running in a container by looking to see if `pid` is in the root of the directory. +#### Future +See the [roadmap](ROADMAP.md). ## Copyright and license Code and documentation copyright 2014 Docker, inc. Code released under the Apache 2.0 license. Docs released under Creative commons. + +## Hacking on libcontainer + +First of all, please familiarise yourself with the [libcontainer Principles](PRINCIPLES.md). + +If you're a *contributor* or aspiring contributor, you should read the [Contributors' Guide](CONTRIBUTORS_GUIDE.md). + +If you're a *maintainer* or aspiring maintainer, you should read the [Maintainers' Guide](MAINTAINERS_GUIDE.md). diff --git a/hack/ROADMAP.md b/ROADMAP.md similarity index 100% rename from hack/ROADMAP.md rename to ROADMAP.md diff --git a/hack/README.md b/hack/README.md deleted file mode 100644 index ad945e78..00000000 --- a/hack/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# Hacking on libcontainer - -The hack/ directory holds information and tools for everyone involved in the process of creating and -distributing libcontainer, specifically: - -## Guides - -If you're a *contributor* or aspiring contributor, you should read CONTRIBUTORS.md. - -If you're a *maintainer* or aspiring maintainer, you should read MAINTAINERS.md. - -## Roadmap - -A high-level roadmap is available at ROADMAP.md. - -## Build tools - -TBD - -## Credits - -The initial documentation in the hack/ directory came from the Docker repository, where libcontainer grew up.