DEV Community

Cover image for Como escrever um README.md sensacional no Github

Como escrever um README.md sensacional no Github

Diana Regina on May 03, 2020

Depois de desenvolver aquele projeto incrível, ter passado vários perrengues com a aplicação e Git, você abriu no Github para a comunidade. Mas a...
Collapse
 
fabianacampanari profile image
Fabiana Campanari

Muito Bom! TKS

Collapse
 
paulinhovba profile image
Paulinho@VBA • Edited

Menina, parabéns! Material completíssimo, didático e muito útil. Grato pela contribuição. Veja o meu resultado, conforme suas dicas: github.com/paulinhovba/DGP-Manager...

Collapse
 
reginadiana profile image
Diana Regina

Muito bacana Paulo!! Gostei do desenvolvimento do README e achei o projeto interessante tambem!! Aproveito para elogiar o teu site pessoal, esta incrivel, muito bom!!

Collapse
 
paulinhovba profile image
Paulinho@VBA

Minha cara, desculpe o "flood" de replyes! Ao postar, recebi mensagem de erro e tentei algumas vezes e todas acabaram entrando. Já deletei os outros posts.

Iniciativas como a sua enriquecem muito a experiência humana. Compartilhar é crescer.

Agradeço pelo elogio, foi feito com muito amor!

Caso queira contribuir, o projeto será disponibilizado no git ainda hoje. Sinta-se livre para utilizar como lhe convier.

Se precisar de algo, estou sempre às ordens.

Um abraço!

Thread Thread
 
reginadiana profile image
Diana Regina

hahaha deve ser bug no site, aconteceu a mesma coisa comigo quando fui te responder. Aliás, me inspirei no teu portfólio para construir o meu: dianaregina.netlify.app/

Thread Thread
 
paulinhovba profile image
Paulinho@VBA

Diana, bom dia! Adorei seu novo site. Ficou muito bom mesmo. Parabéns!

Thread Thread
 
reginadiana profile image
Diana Regina

Obrigada :)

Collapse
 
humbertojr profile image
Humberto Jr • Edited

Bacana demais o tuto Diana
Algum tempo atrás eu ainda esta nos tetos básicos no Github, agora quero deixá-los cada vez mais bonitos, para brilhar os olhos dos visitantes

muito obrigado em me ajudar

Collapse
 
reginadiana profile image
Diana Regina

Obrigada JR, demais!! Só arrasa nos projetos agora :)

Collapse
 
jessicanathany profile image
Jéssica Nathany

Adorei seu artigo, parabéns e já estou usando pra editar o meu aqui. Muito bom menina, parabéns mesmo!

Collapse
 
reginadiana profile image
Diana Regina

Muito obrigada :)

Collapse
 
freitasrayani profile image
Rayani Freitas

Vidas foram salvas!! Muito obrigada por compartilhar ^^'

Collapse
 
umaguzin profile image
uMago

Umas das coisas mais lindas que já li

Collapse
 
reginadiana profile image
Diana Regina

Obrigada :)

Collapse
 
faelribeiro22 profile image
Rafael Ribeiro de Sousa

Excelente artigo. Tem está ferramenta que ajuda a criar uma estrutura inicial bem interessante de readme

Collapse
 
luizgustavo0 profile image
Luiz Gustavo Santos

Ótimo artigo! Parabéns!

Collapse
 
lucaires profile image
Lucas Caires Rodrigues

Muito legal esse post me ajudou muito vlw Diana ta de parabéns!

Collapse
 
rafaelyokoyama profile image
Rafael-Yokoyama

Olá,gostaria de saber como que faz pra deixar em ''micro tabela'' nos desenvolvedores,fiz desse jeito,porém ficou um em baixo do outro

Collapse
 
reginadiana profile image
Diana Regina • Edited

Olá Rafael, a base é fazer uma tabela:

Código:

|dev 1 |dev 2 |dev 3 |dev 4 |
| :---: | :---: | :---: | :---: | 
Enter fullscreen mode Exit fullscreen mode

Resultado:

dev 1 dev 2 dev 3 dev 4

Dentro de cada dev/coluna inserimos uma imagem <img/>, quebra de elementos <br/> e texto <sub><sub/> dentro de um link [](). Dentro dos colchetes colocamos os elementos visiveis e nos parentes o link para o github

Código:

|[<img src="" width="largura da imagem"/><br/><sub>Nome do Dev</sub>]() | [<img src="" width="largura da imagem"/><br/><sub>Outro nome do Dev</sub>]()|
| :---: | :---: | 
Enter fullscreen mode Exit fullscreen mode

Resultado:

Exemplo para 2 colunas:

Código:

[<img src="https://avatars2.githubusercontent.com/u/46378210?s=400&u=071f7791bb03f8e102d835bdb9c2f0d3d24e8a34&v=" width=115 > <br> <sub> Diana Regina </sub>](https://github.com/Diana-ops) | [<img src="https://avatars2.githubusercontent.com/u/46378210?s=400&u=071f7791bb03f8e102d835bdb9c2f0d3d24e8a34&v=" width=115 > <br> <sub> Diana Regina </sub>](https://github.com/Diana-ops) | 
| :---: | :---: |
Enter fullscreen mode Exit fullscreen mode

Resultado:

Exemplo para 4 colunas:

Código:

[<img src="https://avatars2.githubusercontent.com/u/46378210?s=400&u=071f7791bb03f8e102d835bdb9c2f0d3d24e8a34&v=" width=115 > <br> <sub> Diana Regina </sub>](https://github.com/Diana-ops) | [<img src="https://avatars2.githubusercontent.com/u/46378210?s=400&u=071f7791bb03f8e102d835bdb9c2f0d3d24e8a34&v=" width=115 > <br> <sub> Diana Regina </sub>](https://github.com/Diana-ops) | [<img src="https://avatars2.githubusercontent.com/u/46378210?s=400&u=071f7791bb03f8e102d835bdb9c2f0d3d24e8a34&v=" width=115 > <br> <sub> Diana Regina </sub>](https://github.com/Diana-ops) | [<img src="https://avatars2.githubusercontent.com/u/46378210?s=400&u=071f7791bb03f8e102d835bdb9c2f0d3d24e8a34&v=" width=115 > <br> <sub> Diana Regina </sub>](https://github.com/Diana-ops)
| :---: | :---: | :---: | :---: | 
Enter fullscreen mode Exit fullscreen mode

Resultado:

Collapse
 
cmanique profile image
Carlos Manique Silva

Óptima explicação!
Devias fazer em inglês também 😉

Collapse
 
reginadiana profile image
Diana Regina

Obrigada, é uma boa ideia :)

Collapse
 
daianerangel profile image
Daiane Rangel

Ótimo artigo! Parabéns!

Collapse
 
tgmarinhodev profile image
Thiago Marinho

O melhor post que já encontrei sobre o assunto. Parabéns Diana!
Obrigado por compartilhar 📝 🚀

Collapse
 
reginadiana profile image
Diana Regina

Muito obrigada, fico muito feliz :)

Collapse
 
viniciusbds profile image
Vinicius Barbosa

Muito massa. Usei bastante essas dicas no meu projetinho

Collapse
 
devviniciusprado profile image
dev-vinicius-prado

Muito grato pelo material excelente.

Collapse
 
karinecord profile image
KARINE CORDEIRO RIBEIRO

Ótimo post! Obrigada por contribuir! :-)

Collapse
 
easbarba profile image
Alexander Barbosa

Massa

Collapse
 
felssca profile image
FelipeSSCA

Muito bom material. Parabéns !