Eu vou escrever e verificar seu README do github contra o repositório

A maioria dos READMEs parecem bem feitos, mas falham na primeira instrução.

Vou inspecionar seu repositório e transformar sua documentação em um guia de início rápido que um novo usuário realmente consegue seguir. Dependendo do pacote, eu vou:

- mapear as reais pré-requisitos, instalação, execução e testes;

- executar comandos seguros em um espaço de trabalho local limpo, sempre que possível;

- corrigir nomes de arquivos, versões, variáveis de ambiente e exemplos desatualizados;

- separar comportamento verificado de suposições ou serviços indisponíveis;

- melhorar a estrutura, Markdown, resolução de problemas e orientações para colaboradores; e

- retornar um log de verificação mostrando o que passou, falhou ou não pôde ser testado.

Melhor para ferramentas open-source, pequenas bibliotecas, CLIs, APIs e projetos de desenvolvedores.

A IA pode ajudar com o mapeamento do repositório, mas comandos e alegações de material são checados contra o código fornecido e os outputs. Eu não invento resultados de testes.

Não inclui: malware ou código obfuscado, comandos destrutivos, implantação em produção, sistemas que você não possui, certificação de segurança ou segredos. Entre em contato antes de pedir se o projeto precisar de serviços pagos, hardware incomum ou uma grande compilação.