A forma mais fácil de criar um README

README.md é um arquivo com extensão .md (Markdown). Contém informações necessárias para entender o objetivo do projeto. README é uma palavra em inglês que traduzida fica LEIAME.

Podemos considerar o README como um cartão de visita do seu projeto no Github ou em outras plataformas de repositórios remotos de código: Gitlab, Bitbucket, Azure Repos.

Como escrever um README?

Reademe.so - é um simples editor permite adicionar e personalizar facilmente todas as seções que você precisa para o README do seu projeto

screenshot

willieoliveirahá 2 anos

Ótimo! Estou mantendo uma doc aqui e veio como uma luva esta recomendação. Muitos templates prontos ali, aceleram muito o processo e trás uma organização bacana.

Fiquei imaginando que seria muito interessante se eles permitissem um drag and drop nas seções para alterar a ordem do conteúdo no documento que está em edição.

gabrielfpereirahá 2 anos
Mas existe sim um Drag and Drop. Você arrasta clicando nos pontinhos ao lado do nome da Seção.
willieoliveirahá 2 anos
Engraçado, era tão óbvio, havia clicado/arrastado (sem sucesso) e agora com sua resposta voltei para conferir e funcionava como esperado. Vai saber!
rocamarottoshá 2 anos

muito obrigado pela dica, achei bem legal e já estou usando