- Motivos para a existência do arquivo README
- O README é um conteúdo importante que determina a primeira impressão de um projeto de código
- É o rosto do projeto e também seu manual de uso
- Ajuda a entender por que o código existe, qual problema ele resolve e por que ele é importante
- Explica o objetivo do projeto, como instalar e como usar
- Fornece informações importantes para todos que participam do projeto e aumenta o valor do código
- Um excelente README pode ter grande impacto no sucesso do projeto
- O código existe para resolver problemas, e o README deve comunicar com clareza a importância desses problemas e como a solução funciona
- Projeto sem README
- É como um labirinto sem placas de orientação
- O interesse no projeto pode cair, e um projeto útil pode não se tornar amplamente conhecido
- Desenvolvedores têm dificuldade para manter e melhorar o projeto
- Leva muito tempo para entender a estrutura do código existente ou a forma de uso
- Requisitos para escrever um README
- Deve sempre conter informações atualizadas
- Quando houver mudanças no projeto, o README também deve ser atualizado
- O README deve ser conciso, mas ainda assim fornecer todas as informações necessárias
- Se o conteúdo ficar longo, crie novos arquivos por objetivo em caminhos separados e adicione hyperlinks
- O que incluir no README
- Principais funcionalidades e objetivo do projeto
- Método de instalação: guia de instalação passo a passo, ferramentas e bibliotecas necessárias para a instalação, orientação de configuração do ambiente
- Como resolver problemas: problemas frequentes e suas soluções
- Canal de suporte: principais mantenedores do projeto ou responsáveis pela comunicação, e como entrar em contato
- Informações de licença: a licença especifica os direitos e restrições relacionados ao uso, modificação e distribuição do código
- Changelog: principais atualizações do projeto
- Exemplos de uso
- Materiais adicionais de estudo e links para documentação
- Pré-requisitos: com o objetivo de ajudar o usuário a configurar facilmente o ambiente para instalar e executar o projeto
Ainda não há comentários.