Skip to content

Instantly share code, notes, and snippets.

@lohhans

lohhans/README-PTBR.md

Forked from PurpleBooth/README-Template.md
Last active October 28, 2025 11:20
Show Gist options
  • Save lohhans/f8da0b147550df3f96914d3797e9fb89 to your computer and use it in GitHub Desktop.
Save lohhans/f8da0b147550df3f96914d3797e9fb89 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. lohhans revised this gist Aug 25, 2022. 1 changed file with 3 additions and 3 deletions.
    6 changes: 3 additions & 3 deletions README-PTBR.md
    View file
    Original file line number Diff line number Diff line change
    @@ -89,9 +89,9 @@ Este projeto está sob a licença (sua licença) - veja o arquivo [LICENSE.md](h

    ## 🎁 Expressões de gratidão

    * Conte a outras pessoas sobre este projeto 📢
    * Convide alguém da equipe para uma cerveja 🍺
    * Obrigado publicamente 🤓.
    * Conte a outras pessoas sobre este projeto 📢;
    * Convide alguém da equipe para uma cerveja 🍺;
    * Um agradecimento publicamente 🫂;
    * etc.


  2. lohhans revised this gist Aug 25, 2022. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-PTBR.md
    View file
    Original file line number Diff line number Diff line change
    @@ -6,7 +6,7 @@ Um parágrafo da descrição do projeto vai aqui

    Essas instruções permitirão que você obtenha uma cópia do projeto em operação na sua máquina local para fins de desenvolvimento e teste.

    Consulte **[Implantação](#-desenvolvimento)** para saber como implantar o projeto.
    Consulte **[Implantação](#-implanta%C3%A7%C3%A3o)** para saber como implantar o projeto.

    ### 📋 Pré-requisitos

  3. lohhans revised this gist Aug 25, 2022. 1 changed file with 2 additions and 2 deletions.
    4 changes: 2 additions & 2 deletions README-PTBR.md
    View file
    Original file line number Diff line number Diff line change
    @@ -6,7 +6,7 @@ Um parágrafo da descrição do projeto vai aqui

    Essas instruções permitirão que você obtenha uma cópia do projeto em operação na sua máquina local para fins de desenvolvimento e teste.

    Consulte **Implantação** para saber como implantar o projeto.
    Consulte **[Implantação](#-desenvolvimento)** para saber como implantar o projeto.

    ### 📋 Pré-requisitos

    @@ -54,7 +54,7 @@ Explique que eles verificam esses testes e porquê.
    Dar exemplos
    ```

    ## 📦 Desenvolvimento
    ## 📦 Implantação

    Adicione notas adicionais sobre como implantar isso em um sistema ativo

  4. lohhans revised this gist Apr 18, 2019. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-PTBR.md
    View file
    Original file line number Diff line number Diff line change
    @@ -79,7 +79,7 @@ Nós usamos [SemVer](http://semver.org/) para controle de versão. Para as vers
    Mencione todos aqueles que ajudaram a levantar o projeto desde o seu início

    * **Um desenvolvedor** - *Trabalho Inicial* - [umdesenvolvedor](https://github.com/linkParaPerfil)
    * **Fulano De Tal** - *Documentación* - [fulanodetal](https://github.com/linkParaPerfil)
    * **Fulano De Tal** - *Documentação* - [fulanodetal](https://github.com/linkParaPerfil)

    Você também pode ver a lista de todos os [colaboradores](https://github.com/usuario/projeto/colaboradores) que participaram deste projeto.

  5. lohhans revised this gist Apr 18, 2019. No changes.
  6. lohhans revised this gist Apr 18, 2019. 2 changed files with 99 additions and 88 deletions.
    99 changes: 99 additions & 0 deletions README-PTBR.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,99 @@
    # Título do projeto

    Um parágrafo da descrição do projeto vai aqui

    ## 🚀 Começando

    Essas instruções permitirão que você obtenha uma cópia do projeto em operação na sua máquina local para fins de desenvolvimento e teste.

    Consulte **Implantação** para saber como implantar o projeto.

    ### 📋 Pré-requisitos

    De que coisas você precisa para instalar o software e como instalá-lo?

    ```
    Dar exemplos
    ```

    ### 🔧 Instalação

    Uma série de exemplos passo-a-passo que informam o que você deve executar para ter um ambiente de desenvolvimento em execução.

    Diga como essa etapa será:

    ```
    Dar exemplos
    ```

    E repita:

    ```
    Até finalizar
    ```

    Termine com um exemplo de como obter dados do sistema ou como usá-los para uma pequena demonstração.

    ## ⚙️ Executando os testes

    Explicar como executar os testes automatizados para este sistema.

    ### 🔩 Analise os testes de ponta a ponta

    Explique que eles verificam esses testes e porquê.

    ```
    Dar exemplos
    ```

    ### ⌨️ E testes de estilo de codificação

    Explique que eles verificam esses testes e porquê.

    ```
    Dar exemplos
    ```

    ## 📦 Desenvolvimento

    Adicione notas adicionais sobre como implantar isso em um sistema ativo

    ## 🛠️ Construído com

    Mencione as ferramentas que você usou para criar seu projeto

    * [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - O framework web usado
    * [Maven](https://maven.apache.org/) - Gerente de Dependência
    * [ROME](https://rometools.github.io/rome/) - Usada para gerar RSS

    ## 🖇️ Colaborando

    Por favor, leia o [COLABORACAO.md](https://gist.github.com/usuario/linkParaInfoSobreContribuicoes) para obter detalhes sobre o nosso código de conduta e o processo para nos enviar pedidos de solicitação.

    ## 📌 Versão

    Nós usamos [SemVer](http://semver.org/) para controle de versão. Para as versões disponíveis, observe as [tags neste repositório](https://github.com/suas/tags/do/projeto).

    ## ✒️ Autores

    Mencione todos aqueles que ajudaram a levantar o projeto desde o seu início

    * **Um desenvolvedor** - *Trabalho Inicial* - [umdesenvolvedor](https://github.com/linkParaPerfil)
    * **Fulano De Tal** - *Documentación* - [fulanodetal](https://github.com/linkParaPerfil)

    Você também pode ver a lista de todos os [colaboradores](https://github.com/usuario/projeto/colaboradores) que participaram deste projeto.

    ## 📄 Licença

    Este projeto está sob a licença (sua licença) - veja o arquivo [LICENSE.md](https://github.com/usuario/projeto/licenca) para detalhes.

    ## 🎁 Expressões de gratidão

    * Conte a outras pessoas sobre este projeto 📢
    * Convide alguém da equipe para uma cerveja 🍺
    * Obrigado publicamente 🤓.
    * etc.


    ---
    ⌨️ com ❤️ por [Armstrong Lohãns](https://gist.github.com/lohhans) 😊
    88 changes: 0 additions & 88 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,88 +0,0 @@
    # Project Title

    One Paragraph of project description goes here

    ## Getting Started

    These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

    ### Prerequisites

    What things you need to install the software and how to install them

    ```
    Give examples
    ```

    ### Installing

    A step by step series of examples that tell you how to get a development env running

    Say what the step will be

    ```
    Give the example
    ```

    And repeat

    ```
    until finished
    ```

    End with an example of getting some data out of the system or using it for a little demo

    ## Running the tests

    Explain how to run the automated tests for this system

    ### Break down into end to end tests

    Explain what these tests test and why

    ```
    Give an example
    ```

    ### And coding style tests

    Explain what these tests test and why

    ```
    Give an example
    ```

    ## Deployment

    Add additional notes about how to deploy this on a live system

    ## Built With

    * [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
    * [Maven](https://maven.apache.org/) - Dependency Management
    * [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

    ## Contributing

    Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

    ## Versioning

    We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

    ## Authors

    * **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)

    See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

    ## License

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

    ## Acknowledgments

    * Hat tip to anyone whose code was used
    * Inspiration
    * etc

  7. @PurpleBooth PurpleBooth revised this gist May 26, 2018. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -82,7 +82,7 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md

    ## Acknowledgments

    * Hat tip to anyone who's code was used
    * Hat tip to anyone whose code was used
    * Inspiration
    * etc

  8. @PurpleBooth PurpleBooth revised this gist May 26, 2018. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -16,7 +16,7 @@ Give examples

    ### Installing

    A step by step series of examples that tell you have to get a development env running
    A step by step series of examples that tell you how to get a development env running

    Say what the step will be

  9. @PurpleBooth PurpleBooth revised this gist Oct 17, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -6,7 +6,7 @@ One Paragraph of project description goes here

    These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

    ### Prerequisities
    ### Prerequisites

    What things you need to install the software and how to install them

  10. @PurpleBooth PurpleBooth revised this gist Oct 12, 2016. 1 changed file with 3 additions and 3 deletions.
    6 changes: 3 additions & 3 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -58,9 +58,9 @@ Add additional notes about how to deploy this on a live system

    ## Built With

    * Dropwizard - Bla bla bla
    * Maven - Maybe
    * Atom - ergaerga
    * [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
    * [Maven](https://maven.apache.org/) - Dependency Management
    * [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

    ## Contributing

  11. @PurpleBooth PurpleBooth revised this gist Oct 2, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -64,7 +64,7 @@ Add additional notes about how to deploy this on a live system

    ## Contributing

    Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
    Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

    ## Versioning

  12. @PurpleBooth PurpleBooth revised this gist Oct 2, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -18,7 +18,7 @@ Give examples

    A step by step series of examples that tell you have to get a development env running

    Stay what the step will be
    Say what the step will be

    ```
    Give the example
  13. @PurpleBooth PurpleBooth revised this gist Sep 11, 2015. 1 changed file with 1 addition and 3 deletions.
    4 changes: 1 addition & 3 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -64,9 +64,7 @@ Add additional notes about how to deploy this on a live system

    ## Contributing

    Feel free to submit pull requests and issues. If it's a particualy large PR, you may wish to discuss it in an issue first.

    Please note that this project is released with a [Contributor Code of Conduct](code_of_conduct.md). By participating in this project you agree to abide by its terms.
    Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

    ## Versioning

  14. @PurpleBooth PurpleBooth revised this gist Aug 28, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a [Contributor Code of Conduct](c

    ## Versioning

    We use [SemVer](http://semver.org/) for the versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
    We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

    ## Authors

  15. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a [Contributor Code of Conduct](c

    ## Versioning

    We use [SemVer](http://semver.org/) for the version tags available see the tags on this repository.
    We use [SemVer](http://semver.org/) for the versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

    ## Authors

  16. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a [Contributor Code of Conduct](c

    ## Versioning

    We use [SemVer](http://semver.org/) for the versioning. For the tags available, see the [tags on this repository](https://github.com/your/project/tags).
    We use [SemVer](http://semver.org/) for the version tags available see the tags on this repository.

    ## Authors

  17. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a [Contributor Code of Conduct](c

    ## Versioning

    We use [SemVer](http://semver.org/) for the version tags available, see the [tags on this repository](https://github.com/your/project/tags).
    We use [SemVer](http://semver.org/) for the versioning. For the tags available, see the [tags on this repository](https://github.com/your/project/tags).

    ## Authors

  18. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a [Contributor Code of Conduct](c

    ## Versioning

    We use [SemVer](http://semver.org/) for the version tags available, see the tags on this repository.
    We use [SemVer](http://semver.org/) for the version tags available, see the [tags on this repository](https://github.com/your/project/tags).

    ## Authors

  19. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 3 additions and 3 deletions.
    6 changes: 3 additions & 3 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -66,21 +66,21 @@ Add additional notes about how to deploy this on a live system

    Feel free to submit pull requests and issues. If it's a particualy large PR, you may wish to discuss it in an issue first.

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
    Please note that this project is released with a [Contributor Code of Conduct](code_of_conduct.md). By participating in this project you agree to abide by its terms.

    ## Versioning

    We use [SemVer](http://semver.org/) for the version tags available, see the tags on this repository.

    ## Authors

    Names of the current team members!
    * **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)

    See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

    ## License

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

    ## Acknowledgments

  20. @PurpleBooth PurpleBooth revised this gist Aug 25, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -70,7 +70,7 @@ Please note that this project is released with a Contributor Code of Conduct. By

    ## Versioning

    We use [SemVer](http://semver.io/) for the version tags available See the tags on this repository.
    We use [SemVer](http://semver.org/) for the version tags available, see the tags on this repository.

    ## Authors

  21. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 4 additions and 0 deletions.
    4 changes: 4 additions & 0 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -68,6 +68,10 @@ Feel free to submit pull requests and issues. If it's a particualy large PR, you

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

    ## Versioning

    We use [SemVer](http://semver.io/) for the version tags available See the tags on this repository.

    ## Authors

    Names of the current team members!
  22. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -56,7 +56,7 @@ Give an example

    Add additional notes about how to deploy this on a live system

    ## Build With
    ## Built With

    * Dropwizard - Bla bla bla
    * Maven - Maybe
  23. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -56,7 +56,7 @@ Give an example

    Add additional notes about how to deploy this on a live system

    ## Technology
    ## Build With

    * Dropwizard - Bla bla bla
    * Maven - Maybe
  24. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 6 additions and 6 deletions.
    12 changes: 6 additions & 6 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -56,18 +56,18 @@ Give an example

    Add additional notes about how to deploy this on a live system

    ## Technology

    * Dropwizard - Bla bla bla
    * Maven - Maybe
    * Atom - ergaerga

    ## Contributing

    Feel free to submit pull requests and issues. If it's a particualy large PR, you may wish to discuss it in an issue first.

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

    ## Technology Choices

    * Dropwizard - Bla bla bla
    * Maven - Maybe
    * Atom - ergaerga

    ## Authors

    Names of the current team members!
  25. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -67,7 +67,7 @@ Please note that this project is released with a Contributor Code of Conduct. By
    * Dropwizard - Bla bla bla
    * Maven - Maybe
    * Atom - ergaerga
    *

    ## Authors

    Names of the current team members!
  26. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 4 additions and 11 deletions.
    15 changes: 4 additions & 11 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -64,17 +64,10 @@ Please note that this project is released with a Contributor Code of Conduct. By

    ## Technology Choices

    ### Dropwizard

    Bla bla bla

    ### Maven

    Maybe

    ### Atom

    aergaerga
    * Dropwizard - Bla bla bla
    * Maven - Maybe
    * Atom - ergaerga
    *
    ## Authors

    Names of the current team members!
  27. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 15 additions and 1 deletion.
    16 changes: 15 additions & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -62,6 +62,19 @@ Feel free to submit pull requests and issues. If it's a particualy large PR, you

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

    ## Technology Choices

    ### Dropwizard

    Bla bla bla

    ### Maven

    Maybe

    ### Atom

    aergaerga
    ## Authors

    Names of the current team members!
    @@ -76,4 +89,5 @@ This project is licensed under the MIT License - see the LICENSE file for detail

    * Hat tip to anyone who's code was used
    * Inspiration
    * etc
    * etc

  28. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 2 additions and 3 deletions.
    5 changes: 2 additions & 3 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -64,10 +64,9 @@ Please note that this project is released with a Contributor Code of Conduct. By

    ## Authors

    Nils Adermann - <[email protected]> - <https://twitter.com/naderman> - <http://www.naderman.de><br />
    Jordi Boggiano - <[email protected]> - <https://twitter.com/seldaek> - <http://seld.be><br />
    Names of the current team members!

    See also the list of [contributors](https://github.com/composer/composer/contributors) who participated in this project.
    See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

    ## License

  29. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 12 additions and 0 deletions.
    12 changes: 12 additions & 0 deletions README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -38,8 +38,20 @@ Explain how to run the automated tests for this system

    ### Break down into end to end tests

    Explain what these tests test and why

    ```
    Give an example
    ```

    ### And coding style tests

    Explain what these tests test and why

    ```
    Give an example
    ```

    ## Deployment

    Add additional notes about how to deploy this on a live system
  30. @PurpleBooth PurpleBooth revised this gist Jul 21, 2015. 1 changed file with 36 additions and 1 deletion.
    37 changes: 36 additions & 1 deletion README-Template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -30,4 +30,39 @@ And repeat
    until finished
    ```

    End with an example of getting some data out of the system or using it for a little demo
    End with an example of getting some data out of the system or using it for a little demo

    ## Running the tests

    Explain how to run the automated tests for this system

    ### Break down into end to end tests

    ### And coding style tests

    ## Deployment

    Add additional notes about how to deploy this on a live system

    ## Contributing

    Feel free to submit pull requests and issues. If it's a particualy large PR, you may wish to discuss it in an issue first.

    Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

    ## Authors

    Nils Adermann - <[email protected]> - <https://twitter.com/naderman> - <http://www.naderman.de><br />
    Jordi Boggiano - <[email protected]> - <https://twitter.com/seldaek> - <http://seld.be><br />

    See also the list of [contributors](https://github.com/composer/composer/contributors) who participated in this project.

    ## License

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

    ## Acknowledgments

    * Hat tip to anyone who's code was used
    * Inspiration
    * etc