a11y.skipToMainContent
1

Gerador README

Gere arquivos profissionais README.md para seus projetos. Inclua crachás, instruções de instalação, exemplos de uso e diretrizes contribuintes.

README Generator
README.md
More options
Was this tool helpful?
Send output to:
Advertisement

How to use README Generator

  1. Selecione seu tipo de projeto.
  2. Preencha os detalhes do projeto (nome, descrição, pilha de tecnologia).
  3. Configure seções e crachás.
  4. Copie o README.md gerado.

O que é {nome}?

Um gerador README cria arquivos README.md abrangentes para projetos de software. Ele inclui seções para descrição do projeto, instalação, uso, documentação da API, diretrizes contribuindo e informações de licença.

Esta ferramenta fornece modelos para diferentes tipos de projeto (biblioteca, ferramenta CLI, aplicativo web, API) e gera crachás para status de compilação, cobertura, versão e licença.

Advertisement

FAQ

Que secções estão incluídas?
Título, crachás, descrição, instalação, uso, API, contribuição, licença e FAQ seções.
Posso personalizar o modelo?
Sim — ativar ou desativar seções e personalizar conteúdo para cada seção.

Related tools

Author

MW
Marcus Webb"The DevTool Craftsman"

Full-Stack Developer & Tools Architect

Marcus has been writing code since the dial-up era. He has contributed to open-source developer tools, built CI/CD pipelines for startups, and debugged production incidents at 3 AM more times than he would like to admit. His philosophy is that the best developer tool is the one that gets out of your way, and he writes about practical tooling that helps teams ship faster with fewer headaches.

Advertisement