docker-library
/
docs
mirror of https://github.com/docker-library/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #118 from infosiftr/readme 

Add section on generated README.md's
This commit is contained in:
Tianon Gravi 2014-12-03 16:43:32 -08:00
parent 35aa82d3ae 4ebe13b717
commit e6c243ea22
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -45,15 +45,19 @@ This is used to generate a simple `README.md` to put in the image's repo.
Argument is the name of the image, like `golang` and it then outputs the readme Argument is the name of the image, like `golang` and it then outputs the readme
to standard out. to standard out.
## `README-template.md` and `user-feedback.md`
These files are the templates used in building the `<image name>/README.md`
file, in combination with the individual image's files.
## folder `<image name>` ## folder `<image name>`
This is where all the partial and generated files for a given image reside, (ex: This is where all the partial and generated files for a given image reside, (ex:
`golang/`). `golang/`).
## `README-template.md` and `user-feedback.md` ## `<image name>/README.md`
These files are the templates used in building the `<image name>/README.md` This file is generated using `update.sh`.
file, in combination with the individual image's files.
## `<image name>/content.md` ## `<image name>/content.md`