瀏覽代碼

Update README to deemphasize "Stackbrew" and to emphasize contributions slightly more than before (mostly by reordering)

Tianon Gravi 11 年之前
父節點
當前提交
a23871761f
共有 1 個文件被更改,包括 37 次插入26 次删除
  1. 37 26
      README.md

+ 37 - 26
README.md

@@ -1,13 +1,17 @@
-# Stackbrew
+# Docker Official Images
 
-Stackbrew is a web-application that performs continuous building of the docker
-standard library. See `README.md` in the stackbrew subfolder for more
-information.
+## Contributing to the standard library
+
+Thank you for your interest in the Docker official images project! We
+strive to make these instructions as simple and straightforward as
+possible, but if you find yourself lost, don't hesitate to seek us out
+on Freenode IRC in channel `#docker-library`, or by creating a GitHub
+issue here.
 
 ## Library definition files
 
 The library definition files are plain text files found in the `library/`
-subfolder of the stackbrew repository.
+subfolder of the official-images repository.
 
 ### File names
 
@@ -18,40 +22,47 @@ a single file, all images are expected to be created under a different tag.
 
 ### Instruction format
 
-Note: there is no backwards compatibility with the old format. This is part
-of our effort to create strict, unambiguous references to build images upon.
+```
+<docker-tag>: <git-url>@<git-commit-id>
+2.2.0: git://github.com/dotcloud/docker-redis@a4bf8923ee4ec566d3ddc212
+
+<docker-tag>: <git-url>@<git-tag>
+2.4.0: git://github.com/dotcloud/[email protected]
 
-	<docker-tag>:	<git-url>@<git-tag>
-	2.4.0: 	git://github.com/dotcloud/[email protected]
-	<docker-tag>:	<git-url>@<git-commit-id>
-	2.2.0: 	git://github.com/dotcloud/docker-redis@a4bf8923ee4ec566d3ddc212
-    <docker-tag>: <git-url>@<git-tag-or-commit-id>  <dockerfile-dir>
-    2.5.1: git://github.com/dotcloud/[email protected]     tools/dockerfiles/2.5.1
+<docker-tag>: <git-url>@<git-tag-or-commit-id> <dockerfile-dir>
+2.5.1: git://github.com/dotcloud/[email protected] tools/dockerfiles/2.5.1
+```
 
 Stackbrew will fetch data from the provided git repository from the
 provided reference. Generated image will be tagged as `<docker-tag>`.
-If a git tag is removed and added to another commit,
-**you should not expect the image to be rebuilt.** Create a new tag and submit
-a pull request instead.
+If a git tag is removed and added to another commit, **you should not
+expect the image to be rebuilt.** Create a new tag and submit a pull
+request instead.
 
-Optionally, if `<dockerfile-dir>` is present, stackbrew will look for the
-`Dockerfile` inside the specified subdirectory instead of at the root.
-
-## Contributing to the standard library
+Optionally, if `<dockerfile-dir>` is present, Stackbrew will look for the
+`Dockerfile` inside the specified subdirectory instead of at the root
+(and `<dockerfile-dir>` will be used as the "context" for the build).
 
-Thank you for your interest in the stackbrew project! We strive to make these instructions as simple and straightforward as possible, but if you find yourself lost, don't hesitate to seek us out on IRC freenode, channel `#docker` or by creating a github issue.
+### Creating a new repository
 
-### New repository.
 * Create a new file in the library folder. Its name will be the name of your repository.
 * Add your tag definitions using the provided syntax (see above).
 * Add the following line to the top of the file:
 `# maintainer: Your Name <[email protected]> (@github.name)`
-* Create a pull request from your git repository to this one. Don't hesitate to add details as to what your repository does.
+* Create a pull request from your git repository to this one. Please be sure to add details as to what your repository does.
+
+### New tag in existing repository that you're the maintainer of
 
-### New tag in existing repository.
 * Add your tag definition using the instruction format documented above.
-* Create a pull request from your git repository to this one. Don't hesitate to add details.
+* Create a pull request from your git repository to this one. Please be sure to add details about what's new, if possible.
 * In the pull request, mention the repository's maintainers using the `@` symbol (found in the relevant MAINTAINERS file).
 
 ### Change to an existing tag
-* Propose a pull request to the origin repository. Don't hesitate to @-mention one of the stackbrew maintainers.
+
+* Propose a pull request to the origin repository. Don't hesitate to @-mention one of the repository maintainers (found in the relevant MAINTAINERS file).
+
+## Stackbrew
+
+Stackbrew is a web-application that performs continuous building of the
+Docker official images. See `README.md` in the `stackbrew/` subfolder
+for more information.