5

O que é README e porque é tão importante !

#GitHub #Git
Ana Silva
Ana Silva

📝 O que é o README?


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

⌨️ O que é Markdown?

Markdown é uma ferramenta de conversão de texto em HTML. Você escreve usando texto simples de fácil leitura e fácil escrita e depois é transformado em um HTML válido.


## Isso é equivalente ao h2 do html, usado para título
Essa é uma maneira simples de deixar o texto **negrito** e palavras *itálicas* com Markdown.
Como é fácil fazer um link para um site: [link p/ Site da DIO!](https://digitalinnovation.one/)

### Lista de todo:
- Estudar Node
- Estudar React 
- Estudar React Native

### Prioridades nos estudos
1. Estudar
2. Praticar
3. Revisar

> Eu sou um bloco de citação (blockquotes)


| Tabelas  |      São      |  Legais |
|----------|:-------------:|------:|
| col 1 is |  left-aligned | $1600 |
| col 2 is |    centered   |   $12 |
| col 3 is | right-aligned |    $1 |


😎 Por que o README é tão importante?


Os projetos que se destacam no Github, além daqueles que resolvem o problema da comunidade, também são aqueles bem documentados em um bom README. Ele facilita a leitura do seu projeto, o que você fez nele e quais tecnologias usou paras eu desenvolvimento.

Sem contar que isso faz com que os recrutadores olhem de outra forma para seu portfólio. Algumas empresas não pedem um Curriculo, apenas seu portfólio, então é preciso apresentar -se bem.

----------------------------------------------------------------------------------

Saiba Mais aqui:

https://blog.rocketseat.com.br/como-fazer-um-bom-readme/

https://www.makeareadme.com/

https://docs.pipz.com/central-de-ajuda/learning-center/guia-basico-de-markdown#open

0
74

Comentários (0)

"A ship in port is safe; but that is not what ships are built for. Sail out to sea and do new things." Grace Hopper

Brasil