Toolipedia Incorporar
PT
← Todas as ferramentas de texto

Gerador de README

Crie um bom README.md com badges, passos de instalação e seções, com visualização.

  • Grátis
  • Sem cadastro
  • Funciona em qualquer dispositivo

Cerca de Gerador de README

Preencha o nome do projeto, a descrição, os passos de instalação, o uso, os recursos, as notas de contribuição e a licença, adicione selos e obtenha um README.md pronto com visualização ao vivo. Um bom README responde rapidamente a três perguntas: o que faz, como instalar e como usar, com um pequeno exemplo.

Como usar: Gerador de README

  1. Preencha o nome do projeto, a descrição e os passos de instalação.
  2. Marque as seções e os selos que você quer.
  3. Copie o README.md da prévia para o seu repositório.

Por que usar esta ferramenta?

Também conhecido como

Perguntas frequentes

O que um bom README deve incluir?

Uma breve descrição, os passos de instalação, um exemplo de uso, como contribuir e a licença. Capturas de tela e selos ajudam, mas são opcionais.

Qual deve ser o tamanho de um README?

Longo o bastante para explicar o que o projeto faz, como instalá-lo e como usá-lo. Adicione mais só se as pessoas fizerem as mesmas perguntas de novo.

Devo incluir capturas de tela?

Para aplicativos e interfaces, sim. Adicione links de imagens no Markdown depois de gerar, pois o README é texto simples.

Gerador de README é grátis?

Sim. Gerador de README no Toolipedia é de uso gratuito, sem cadastro e sem marca d'água.

É seguro usar?

Sim. Tudo é calculado no seu navegador, e nada do que você digita é enviado ao nosso servidor.

Funciona no meu celular?

Sim. Funciona em qualquer navegador moderno no Android e no iPhone, além de tablets e computadores. Não é preciso instalar nada.

Preciso de uma conta?

Não. É só abrir a página e usar a ferramenta. Sem cadastro e sem e-mail.

Posso colocar Gerador de README no meu próprio site?

Sim. Use o botão «Incorporar no seu site» abaixo da ferramenta para copiar um trecho curto de código e colá-lo na sua página. É grátis, não precisa de conta e a ferramenta continua funcionando dentro da sua página.

Ferramentas relacionadas