Devnático
TemplateProgramação

Template de README

Uma estrutura de README que cobre contexto, instalação, uso e decisões importantes, sem virar um texto genérico que ninguém lê.

Recurso de demonstração. O arquivo final para download será adicionado posteriormente.

Estrutura sugerida

  1. O que o projeto faz (1-2 frases)
  2. Como instalar e rodar localmente
  3. Como rodar os testes
  4. Decisões importantes de arquitetura (se houver)
  5. Como contribuir
documentacaoreadme