DEV Community

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...

Read full post

Paulinho@VBA • May 30 '20 • 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...

Diana Regina • May 30 '20

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!!

Paulinho@VBA • May 30 '20

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!

Diana Regina • Jun 1 '20

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/

Paulinho@VBA • Jun 1 '20

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

Diana Regina • Jun 5 '20

Obrigada :)

Fabiana Campanari • Dec 14 '22

Muito Bom! TKS

Humberto Jr • Sep 28 '20 • 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

Diana Regina • Sep 30 '20

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

Rafael Ribeiro de Sousa • May 11 '20

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

Luiz Gustavo Santos • Jun 14 '20

Ótimo artigo! Parabéns!

Carlos Manique Silva • May 3 '20

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

Diana Regina • May 3 '20

Obrigada, é uma boa ideia :)

Rayani Freitas • Sep 8 '20

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

Rafael-Yokoyama • Jun 9 '20

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

Diana Regina • Jun 10 '20 • Edited

Olá Rafael, a base é fazer uma tabela:

Código:

|dev 1 |dev 2 |dev 3 |dev 4 |
| :---: | :---: | :---: | :---: |

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>]()|
| :---: | :---: |

Resultado:

_{Nome do Dev}	_{Outro nome do Dev}

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) | 
| :---: | :---: |

Resultado:

_{Diana Regina}	_{Diana Regina}

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)
| :---: | :---: | :---: | :---: |

Resultado: