Browse code
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)
Phil Estes authored on 2015/07/10 23:42:17Showing 1 changed files
| ... | ... |
@@ -1,17 +1,17 @@ |
| 1 | 1 |
# Hacking on Docker |
| 2 | 2 |
|
| 3 |
-The hack/ directory holds information and tools for everyone involved in the process of creating and |
|
| 3 |
+The `project/` directory holds information and tools for everyone involved in the process of creating and |
|
| 4 | 4 |
distributing Docker, specifically: |
| 5 | 5 |
|
| 6 | 6 |
## Guides |
| 7 | 7 |
|
| 8 |
-If you're a *contributor* or aspiring contributor, you should read CONTRIBUTORS.md. |
|
| 8 |
+If you're a *contributor* or aspiring contributor, you should read [CONTRIBUTORS.md](../CONTRIBUTING.md). |
|
| 9 | 9 |
|
| 10 |
-If you're a *maintainer* or aspiring maintainer, you should read MAINTAINERS.md. |
|
| 10 |
+If you're a *maintainer* or aspiring maintainer, you should read [MAINTAINERS](../MAINTAINERS). |
|
| 11 | 11 |
|
| 12 |
-If you're a *packager* or aspiring packager, you should read PACKAGERS.md. |
|
| 12 |
+If you're a *packager* or aspiring packager, you should read [PACKAGERS.md](./PACKAGERS.md). |
|
| 13 | 13 |
|
| 14 |
-If you're a maintainer in charge of a *release*, you should read RELEASE-CHECKLIST.md. |
|
| 14 |
+If you're a maintainer in charge of a *release*, you should read [RELEASE-CHECKLIST.md](./RELEASE-CHECKLIST.md). |
|
| 15 | 15 |
|
| 16 | 16 |
## Roadmap |
| 17 | 17 |
|
| ... | ... |
@@ -20,5 +20,5 @@ A high-level roadmap is available at [ROADMAP.md](../ROADMAP.md). |
| 20 | 20 |
|
| 21 | 21 |
## Build tools |
| 22 | 22 |
|
| 23 |
-make.sh is the primary build tool for docker. It is used for compiling the official binary, |
|
| 23 |
+[hack/make.sh](../hack/make.sh) is the primary build tool for docker. It is used for compiling the official binary, |
|
| 24 | 24 |
running the test suite, and pushing releases. |