moby/project/README.md

# Hacking on Docker

The `project/` directory holds information and tools for everyone involved in the process of creating and
distributing Docker, specifically:

## Guides

If you're a *contributor* or aspiring contributor, you should read [CONTRIBUTING.md](../CONTRIBUTING.md).

If you're a *maintainer* or aspiring maintainer, you should read [MAINTAINERS](../MAINTAINERS).

If you're a *packager* or aspiring packager, you should read [PACKAGERS.md](./PACKAGERS.md).

If you're a maintainer in charge of a *release*, you should read [RELEASE-CHECKLIST.md](./RELEASE-CHECKLIST.md).

## Roadmap

A high-level roadmap is available at [ROADMAP.md](../ROADMAP.md).


## Build tools

[hack/make.sh](../hack/make.sh) is the primary build tool for docker. It is used for compiling the official binary,
running the test suite, and pushing releases.
hack/MAINTAINERS.md: a maintainer's manual. 2013-09-19 00:26:36 +00:00			`# Hacking on Docker`

Add links and correct locations in project/README.md After removing the duplicate ROADMAP in a separate PR, a few other issues were noted in README.md which are fixed here: - the directory is project, not hack - make.sh is no longer in the current dir since hack/ is not project/ anymore - MAINTAINERS is no longer here as a markdown file, but is a TOML file in the root of the project - links were added to all files to make it easier to follow from here to the appropriate location Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp) 2015-07-10 14:42:17 +00:00			The `project/` directory holds information and tools for everyone involved in the process of creating and
hack/MAINTAINERS.md: a maintainer's manual. 2013-09-19 00:26:36 +00:00			`distributing Docker, specifically:`

Hack: update README 2013-09-19 00:45:56 +00:00			`## Guides`

Rename project/CONTRIBUTORS.md -> project/CONTRIBUTING.md Signed-off-by: Manjunath A Kumatagi <mkumatag@in.ibm.com> 2017-03-15 12:42:18 +00:00			`If you're a contributor or aspiring contributor, you should read [CONTRIBUTING.md](../CONTRIBUTING.md).`
hack/MAINTAINERS.md: a maintainer's manual. 2013-09-19 00:26:36 +00:00
Add links and correct locations in project/README.md After removing the duplicate ROADMAP in a separate PR, a few other issues were noted in README.md which are fixed here: - the directory is project, not hack - make.sh is no longer in the current dir since hack/ is not project/ anymore - MAINTAINERS is no longer here as a markdown file, but is a TOML file in the root of the project - links were added to all files to make it easier to follow from here to the appropriate location Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp) 2015-07-10 14:42:17 +00:00			`If you're a maintainer or aspiring maintainer, you should read [MAINTAINERS](../MAINTAINERS).`
hack/MAINTAINERS.md: a maintainer's manual. 2013-09-19 00:26:36 +00:00
Add links and correct locations in project/README.md After removing the duplicate ROADMAP in a separate PR, a few other issues were noted in README.md which are fixed here: - the directory is project, not hack - make.sh is no longer in the current dir since hack/ is not project/ anymore - MAINTAINERS is no longer here as a markdown file, but is a TOML file in the root of the project - links were added to all files to make it easier to follow from here to the appropriate location Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp) 2015-07-10 14:42:17 +00:00			`If you're a packager or aspiring packager, you should read [PACKAGERS.md](./PACKAGERS.md).`
Hack: update release checklist and reference it in REAMDE 2013-09-19 00:41:08 +00:00
Add links and correct locations in project/README.md After removing the duplicate ROADMAP in a separate PR, a few other issues were noted in README.md which are fixed here: - the directory is project, not hack - make.sh is no longer in the current dir since hack/ is not project/ anymore - MAINTAINERS is no longer here as a markdown file, but is a TOML file in the root of the project - links were added to all files to make it easier to follow from here to the appropriate location Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp) 2015-07-10 14:42:17 +00:00			`If you're a maintainer in charge of a release, you should read [RELEASE-CHECKLIST.md](./RELEASE-CHECKLIST.md).`
Hack: update README 2013-09-19 00:45:56 +00:00
			`## Roadmap`

No need for the old project/ROADMAP.md Now that we have ROADMAP.md in the root of the project, the outdated and non-specific ROADMAP.md in project/ can be removed. Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp) 2015-07-09 20:20:56 +00:00			`A high-level roadmap is available at [ROADMAP.md](../ROADMAP.md).`
Hack: update README 2013-09-19 00:45:56 +00:00

			`## Build tools`

Add links and correct locations in project/README.md After removing the duplicate ROADMAP in a separate PR, a few other issues were noted in README.md which are fixed here: - the directory is project, not hack - make.sh is no longer in the current dir since hack/ is not project/ anymore - MAINTAINERS is no longer here as a markdown file, but is a TOML file in the root of the project - links were added to all files to make it easier to follow from here to the appropriate location Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp) 2015-07-10 14:42:17 +00:00			`[hack/make.sh](../hack/make.sh) is the primary build tool for docker. It is used for compiling the official binary,`
Hack: update README 2013-09-19 00:45:56 +00:00			`running the test suite, and pushing releases.`