Gerador de README.md
Monte um README.md com título, descrição, instalação, uso, contribuição, licença e autor, em português ou inglês.
- Roda no seu navegador
Resultado
O resultado aparece aqui.
O que o README gerado traz
O arquivo começa pelo nome e pela descrição e acrescenta só as seções que você preencher: instalação, uso, contribuição, licença e autor.
No exemplo completo em português as seções são: Instalação, Uso, Contribuindo, Licença, Autor. Em inglês, Installation, Usage, Contributing, License, Author.
Detalhes do preenchimento
- Os comandos de instalação saem em um bloco de código bash, e o uso em um bloco simples. Texto com três crases seguidas é recusado, para não quebrar o bloco.
- A seção de licença só cita o nome e manda ver o arquivo LICENSE; gere o texto da licença na ferramenta própria.
- A saída é Markdown simples, sem emojis, selos nem sumário: edite à vontade depois de copiar.
Perguntas frequentes
Como usar o gerador de readme para projeto?
Informe o nome, a descrição e, se quiser, os comandos de instalação e de uso. As seções vazias não aparecem no arquivo.
O gerador de readme md serve para inglês?
Sim: escolha o idioma e os títulos das seções e as frases fixas saem em inglês ou em português. O que você digitar não é traduzido.