Skip to content

Instantly share code, notes, and snippets.

@hi-hi-ray

hi-hi-ray/Template-README-for-containers.md

Forked from PurpleBooth/Template-README-for-containers.md
Last active February 24, 2021 16:22
Show Gist options
  • Save hi-hi-ray/6ca085c96c6bd5e96c6b1609218d24ce to your computer and use it in GitHub Desktop.
Save hi-hi-ray/6ca085c96c6bd5e96c6b1609218d24ce to your computer and use it in GitHub Desktop.
Download ZIP
(PT-BR/EN) Readme com docker | Readme with docker
Raw
Template-README-for-containers.md

Docker Container Name

Uma descrição de um parágrafo sobre o contêiner.

Começando

Essas instruções irão cobrir informações de uso e para o recipiente do docker

Pré-requisitos

Para executar este recipiente, você precisará do docker instalado.

Uso

Parâmetros do recipiente

Liste os diferentes parâmetros disponíveis para o seu recipiente

docker run give.example.org/of/your/container:v0.2.1 parameters

Um exemplo por permutação

Docker execute give.example.org/of/your/container:v0.2.1

Mostre como obter um shell iniciado no seu recipiente também

Docker execute give.example.org/of/your/container:v0.2.1 bash

Variáveis De Ambiente

  • VARIABLE_ONE - Descrição
  • ANOTHER_VAR - Mais descrição
  • YOU_GET_THE_IDEA - E outro

Volumes

  • / Your / file / location - Localização do arquivo

Locais de arquivos úteis

  • / Some / special / script.sh - Lista de scripts especiais   
  • / Magic / dir - E também diretórios

Built With

  • Listar o software v0.1.3
  • E os números de versão v2.0.0
  • Que estão neste recipiente v0.3.2

Ache-nos

Contribuindo

Leia CONTRIBUTING.md para obter detalhes sobre nosso código de conduta e o processo para enviar pedidos de extração para nós.

Versioning

Usamos SemVer para versões. Para as versões disponíveis, veja o Tags neste repositório.

Autores

  • ** Billie Thompson ** - * Trabalho inicial * - PurpleBooth
  • ** Raysa Dutra ** - * Tradução Pt-Br * - hi-hi-ray

Veja também a lista de contribuidores que Participou deste projeto.

Licença

Este projeto está licenciado sob a licença MIT - veja o arquivo LICENSE.md para obter detalhes.

Agradecimentos

  • Pessoas que você deseja agradecer
  • Se você pegou um monte de código de algum lugar, liste-o aqui

Docker Container Name

A one paragraph description about the container.

Getting Started

These instructions will cover usage information and for the docker container

Prerequisities

In order to run this container you'll need docker installed.

Usage

Container Parameters

List the different parameters available to your container

docker run give.example.org/of/your/container:v0.2.1 parameters

One example per permutation

docker run give.example.org/of/your/container:v0.2.1

Show how to get a shell started in your container too

docker run give.example.org/of/your/container:v0.2.1 bash

Environment Variables

  • VARIABLE_ONE - A Description
  • ANOTHER_VAR - More Description
  • YOU_GET_THE_IDEA - And another

Volumes

  • /your/file/location - File location

Useful File Locations

  • /some/special/script.sh - List special scripts

  • /magic/dir - And also directories

Built With

  • List the software v0.1.3
  • And the version numbers v2.0.0
  • That are in this container v0.3.2

Find Us

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

  • People you want to thank
  • If you took a bunch of code from somewhere list it here
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment