Skip to content

Instantly share code, notes, and snippets.

@hi-hi-ray
Forked from PurpleBooth/README-Template.md
Last active May 19, 2024 19:29
Show Gist options
  • Save hi-hi-ray/4b54aa4996604cc76c05304c6fa7cae1 to your computer and use it in GitHub Desktop.
Save hi-hi-ray/4b54aa4996604cc76c05304c6fa7cae1 to your computer and use it in GitHub Desktop.
(PT-BR/EN) Um template de um bom Readme | A template to make good README.md

Título do projeto

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

Começando

Essas instruções fornecerão uma cópia do projeto em funcionamento em sua máquina local para fins de desenvolvimento e teste. Consulte a implantação de notas sobre como implantar o projeto em um sistema ao vivo.

Pré-requisitos

O que você precisa para instalar o software e como instalá-los

Dar exemplos

Instalando

Uma série passo a passo de exemplos que lhe dizem que você deve ter um desenvolvimento env em execução

Diga o que o passo será

  Dê o exemplo

E repita

  Até terminar

Termine com um exemplo de tirar alguns dados do sistema ou usá-lo para um pequeno demo

Executando os testes

Explique como executar os testes automatizados para este sistema

Divulgue em testes de ponta a ponta

Explique o que esses testes testam e por que

  Dê um exemplo

E testes de estilo de codificação

Explique o que esses testes testam e por que

  Dê um exemplo

Desdobramento, desenvolvimento

Adicione notas adicionais sobre como implantar isso em um sistema ao vivo

Built With

  • Nome - Usada para algo...

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 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 participaram deste projeto.

Licença

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

Agradecimentos

  • Dica de um pessoa
  • Inspiração
  • Etc.

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 have 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 - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

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

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc
@alfeups
Copy link

alfeups commented Jun 3, 2021

Estou começando minha jornada e estava procurando exatamente por isso, muito obrigado!

@Fabiano-Vaz
Copy link

muito obrigado, me ajudou muito!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment