Awesome README
Ao entrar em um projeto, antes de olhar códigos a primeira informação que vemos é o que está no README, então nada mais justo do que fazer um README espetacular.
Logo
Caso o sistema já tenha uma logo definida começamos por ela
Título
Deixe um título para seu projeto, se não tem um bom nome, pode colocar o nome do projeto.
# titleBadge
Os badge além de deixar mais elegante, nos ajuda com informações rápidas então se possível adicione no seu projeto, um exemplo seria o badge do travis que informa se passou no teste ou não
[](https://travis-ci.org/walternascimentobarroso/walternascimentobarroso.github.io)Obs.: caso queira criar o seu proprio o site https://shields.io/ é uma otima ferramenta
Menu
Ao deixar bem descritivo o README acaba ficando muito extenso, para não gerar uma leitura cansativa é interessante ter um pequeno menu.
[Overview](#overview)•[Doc](#doc)•[Demo](#demo)
caso o menu fique muito grande mude de lateral para horizontal.
## :bookmark_tabs: Menu* [Overview](#overview)
* [Doc](#doc)
Obs.: Insira os tópicos do README em links para facilitar a navegação do leitor
Overview
Aqui você deve dar uma descrição rápida do que o sistema faz
## :scroll: OverviewBreve descrição do projeto.
Screenshot
Nem todos tem tempo de verificar e rodar o projeto, o ideal é tem alguns screenshots do projeto logo no início
## :rice_scene: Screenshot
Obs.: Um gif apresentando o projeto é muito útil.
Demo
Agora vem uma das partes mais importante, a demonstração, caso seu projeto já esteja publicado e tenha uma forma de testar sem ter que baixar o projeto deixe o link para um acesso rápido aqui, e se for necessário fazer login deixe os dados aqui também.
## :dvd: DemoLorem ipsum dolor sit amet consectetur, adipisicing elit.
| url | login | password || ------------------------ | -------------- | -------- || http://exemplo.com/admin | admin@mail.com | 123 |
Documentation
Se seu sistema possui documentação, deixe um link para tal aqui.
## :blue_book: DocumentationDocumentation lives at readthedocs.org
Requirements
Se você quer que usem seu sistema, deixe os pré-requisitos necessários descritos aqui, assim evita de depois de baixar ter que ir em todos os arquivos verificar qual os itens necessários.
## :heavy_exclamation_mark: Requirements* [Node](https://nodejs.org/en/download/)* [PHP](https://php.net/)
Installation and usage
Aqui você descreve como deve ser executado seu sistema para que ele funcione corretamente
## Installation and usage```git clone https://github.com/<user>/<project>```
Obs.: Coloque um passo a passo para rodar a sua aplicação.
Tests
Coloque um passo a passo para executar os testes
### Tests```
$ npm run test
```
Dependencies and libs
Alguns gostam de listar cada lib utilizada, caso você queira aqui é um bom lugar
### Dependencies and libs- [React](https://pt-br.reactjs.org/docs/create-a-new-react-app.html)- [React PDF](https://react-pdf.org/)
Folder Structure
Se o projeto possui uma organização única de pastas é útil deixar essa informação explícita.
### Folder Structure```.
├── src # Project source code
├── doc # Doc for the project
├── .gitignore
├── LICENSE
└── README.md```
Obs.: Se usa o linux e quer exibi algo desse tipo o programa tree é muito bom `sudo apt install tree -y`
Release History
Se é um projeto grande com muitas melhorias já realizadas, é interessante ter um changelog
- 0.2.0
- CHANGE: Remove function
- ADD: Add init()
- 0.1.1
- FIX: Crash when calling baz()
- 0.1.0
- CHANGE: Rename foo() to bar()
- 0.0.1
- Init the projectContributing
Deixe de uma forma simples como contribuir para seu projeto
1. Fork it (https://github.com/yourname/yourproject/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am ‘Add some fooBar’)
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull RequestTasks
Se for o caso, liste tarefas/funcionalidades que ainda precisam ser implementadas na sua aplicação
## :bell: Tasks- [ ] Task 1- [x] Task 2- [x] Task 3- [ ] Task 4
Authors
Se quiser identificar os autores do projeto aqui é o lugar
## :smiley_cat: Authors- [@walternascimentobarroso](https://walternascimentobarroso.github.io/)
License
Por fim adiciona o tipo de licença que seu projeto possui.
## :memo: LicenseThe [MIT License]() (MIT)
Templat
Para usar o templat completo veja o link:
Observações:
- Todas as informações são opcionais, não é obrigatório usar tudo, mas quanto mais informação melhor ;)
- Como o markdown não tem ajuste de css nativo é necessário o uso de algumas tags e atributos antigos para simular um layout mais elegante
Extras
Segui algumas ferramentas para criar seu readme
Para outros exemplos veja o link abaixo:
Obrigado por ler!
Se você tiver alguma dúvida, reclamação ou dica, pode deixar aqui nos comentários. Vou ter o maior prazer em responder!
😊😊Até mais! 😊😊
