35 lines
1.6 KiB
Bash
Executable File
35 lines
1.6 KiB
Bash
Executable File
#!/bin/bash
|
|
set -e
|
|
|
|
cd "$(dirname "$(readlink -f "$BASH_SOURCE")")"
|
|
|
|
repo="$1"
|
|
|
|
if [ -z "$repo" ]; then
|
|
echo >&2 'error: no repo specified'
|
|
cat >&2 <<EOUSAGE
|
|
usage: $0 repo [> README.md]
|
|
ie: $0 php > ../php/README.md
|
|
|
|
This script generates a stub README to standard out for the specified repo.
|
|
EOUSAGE
|
|
exit 1
|
|
fi
|
|
|
|
gitRepo='https://github.com/docker-library/docs'
|
|
hubPage="https://registry.hub.docker.com/_/$repo/"
|
|
|
|
cat <<EOREADME
|
|
# About this Repo
|
|
|
|
This is the Git repo of the Docker [official image](https://docs.docker.com/docker-hub/official_repos/) for [$repo]($hubPage). See [the Docker Hub page]($hubPage) for the full readme on how to use this Docker image and for information regarding contributing and issues.
|
|
|
|
The full readme is generated over in [docker-library/docs]($gitRepo), specificially in [docker-library/docs/$repo]($gitRepo/tree/master/$repo).
|
|
|
|
See a change merged here that doesn't show up on the Docker Hub yet? Check [the "library/$repo" manifest file in the docker-library/official-images repo](https://github.com/docker-library/official-images/blob/master/library/$repo), especially [PRs with the "library/$repo" label on that repo](https://github.com/docker-library/official-images/labels/library%2F$repo). For more information about the official images process, see the [docker-library/official-images readme](https://github.com/docker-library/official-images/blob/master/README.md).
|
|
|
|
[](https://travis-ci.org/docker-library/$repo/branches)
|
|
|
|
<!-- THIS FILE IS GENERATED BY https://github.com/docker-library/docs/blob/master/generate-repo-stub-readme.sh -->
|
|
EOREADME
|