Skip to content

Instantly share code, notes, and snippets.

@Raph2ll
Forked from lohhans/README-PTBR.md
Last active January 19, 2023 19:11
Show Gist options
  • Save Raph2ll/1841e399259e36f2e5d7c434eddd741d to your computer and use it in GitHub Desktop.
Save Raph2ll/1841e399259e36f2e5d7c434eddd741d to your computer and use it in GitHub Desktop.
Meu modelo de README.md para Projetos

Título do projeto

Um parágrafo da descrição do projeto vai aqui, aproveite também para dar o contexto do projeto.

🔖 Sumário

🚀 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.

No terminal, clone o repositório:

git clone [email protected]:Raph2ll/___.git

📋 Pré-requisitos

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

Dar exemplos: [Javascript, NPM, Docker, Node]

🔧 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

⌨️ Testes de estilo de codificação

Encontra e corrije problemas no código, relacionado a indentação e sintaxe.

ESLint:

npm run eslint

🛠️ Construído com

Mencione as ferramentas que você usou para criar seu projeto

🎥 Imagens

Separe esse espaço para GIF's ou fotos da aplicação.

🖇️ Colaborando

Por favor, leia o COLABORACAO.md 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 NPM📦 para controle de versão das dependências.

✒️ Autores

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

Você também pode ver a lista de todos os colaboradores que participaram deste projeto.

📄 Licença

Este projeto está sob a licença (sua licença) - veja o arquivo LICENSE.md para detalhes.

🎁 Expressões de gratidão

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

⌨️ com ❤️ por Raphael

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