Template sugestivo para documentação de projetos

README-TEMPLATE.md

Titulo ou Arte do Projeto

Status do Projeto: ✔️ ⚠️ (concluido, em desenvolvimento, etc)

Tópicos

🔹 Descrição do projeto

🔹 Funcionalidades

🔹 Deploy da Aplicação

🔹 Pré-requisitos

🔹 Como rodar a aplicação

...

Insira os tópicos do README em links para facilitar a navegação do leitor

Descrição do projeto

Descrição breve do projeto compondo um paragrafo ou dois.

Funcionalidades

✔️ Funcionalidade 1

✔️ Funcionalidade 2

✔️ Funcionalidade 3

✔️ Funcionalidade 4

Layout ou Deploy da Aplicação 💨

Link do deploy da aplicação. Exemplo com netlify: https://certificates-for-everyone-womakerscode.netlify.app/

...

Se ainda não houver deploy, insira capturas de tela da aplicação ou gifs

Pré-requisitos

⚠️ Node

...

Liste todas as dependencias e libs que o usuário deve ter instalado na máquina antes de rodar a aplicação

Como rodar a aplicação ▶️

No terminal, clone o projeto:

git clone https://github.com/React-Bootcamp-WoMarkersCode/certificate-generator

...

Coloque um passo a passo para rodar a sua aplicação. Dica: clone o próprio projeto e verfique se o passo a passo funciona

Como rodar os testes

Coloque um passo a passo para executar os testes

$ npm test, rspec, etc 

Casos de Uso

Explique com mais detalhes como a sua aplicação poderia ser utilizada. O uso de gifs aqui seria bem interessante.

Exemplo: Caso a sua aplicação tenha alguma funcionalidade de login apresente neste tópico os dados necessários para acessá-la.

JSON 💾

Usuários:

name	email	password	token	avatar
Lais Lima	[email protected]	lais123	true	https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcS9-U_HbQAipum9lWln3APcBIwng7T46hdBA42EJv8Hf6Z4fDT3&usqp=CAU

...

Se quiser, coloque uma amostra do banco de dados

Iniciando/Configurando banco de dados

Se for necessário configurar algo antes de iniciar o banco de dados insira os comandos a serem executados

Linguagens, dependencias e libs utilizadas 📚

• React
• React PDF

...

Liste as tecnologias utilizadas no projeto que não forem reconhecidas pelo Github

Resolvendo Problemas ❗

Em issues foram abertos alguns problemas gerados durante o desenvolvimento desse projeto e como foram resolvidos.

Tarefas em aberto

Se for o caso, liste tarefas/funcionalidades que ainda precisam ser implementadas na sua aplicação

📝 Tarefa 1

📝 Tarefa 2

📝 Tarefa 3

Desenvolvedores/Contribuintes

Liste o time responsável pelo desenvolvimento do projeto

Diana Regina	Diana Regina	Diana Regina

Licença

The MIT License (MIT)

Copyright ©️ Ano - Titulo do Projeto

Muito bom, obrigada por compartilhar :)

Parabéns pelo trabalho! Já está salvo nos meus favoritos.

Caramba, um trabalho incrível, Estou aprendendo muito com esse template.
Parabéns!

Parabéns! vai ajudar muito para quem esta começando como eu kkkk.

Nossa gostei muito de tudo, estava procurando uma melhor forma de documentar aplicações, e a sua é muito, muito, muito boa mesmo. Gostei, nota 1000.

Gostei bastante do artigo e desse modelo de README, estou começando e vai me ajudar bastante😀👍

Parabéns Regina pelo fantástico trabalho! me ajudou pra caramba, principalmente pra criar os badges. Agora eu já tentei criar um badges com a logo do NODE só não aparece a logo. Tem alguma uma dica pra isso?!

@emersonpessoa01

Puts, tem alguns logos que não estão disponíveis mesmo. Uma coisa que a galera faz é mandar uma url da imagem como parâmetro na logo. Encontrei esse tópico no stackoverflow.

Ele fala basicamente que tu precisa de uma imagem com base64. Podemos usar esse site que faz a conversão de uma imagem para esse tipo de base e colocar na LOGO. Porém, não achei que foi um caminho muito consistente, mesmo fazendo a conversão não foram todas as imagens que deram certo.

Uma alternativa que achei bacana foi essa da documentação dos shields.

Eles usam o site Simple Icons. Podemos simplesmente referenciar o nome que queremos. Exemplo:

Escolhi esse icon aqui (sim, esse é o logo de node que eles tem, pelo menos foi o que achei).

Show, poderíamos ter um badge da seguinte forma:

https://img.shields.io/static/v1?label=nodejs&message=backend&color=green&style=for-the-badge&logo=node.js

Parece ter muitos icons disponíveis!!

Show de bola, Regina!!! Obrigado.

Shoooooowww Regina!
Vai me ajudar muito!!!
Obrigado e Parabéns!

Muito bom!!! Parabéns!!!

show

Muito bom !! Excelente material !!

Muito bom!! Vai meu ajudar bastante 😉
Parabéns! 👏👏

Obrigado por compartilhar!

Me salvou muito, nossa que trabalho incrível, obrigado❤❤❤

Muuuuuitissimo obg. To iniciando nesse mundo louco de quebrar cabeça p encontrar soluçoes kkk Seu template esta muito lindo e organizado de uma forma super intuitiva. Vai me ajudar dmais!

Excelente, muito obrigado !

Obrigada! Me ajudou muito!!

Obrigado por disponibilizar esse exemplo de README. pretendo usar em meus projetos

Top demais, pretendo usar como modelo para os meus.

Muito obrigado, vou usar para melhorar a documentação dos meus projetos do github

Muito top, parabéns @reginadiana show de bola. Não consegui colocar a minha imagem no Desenvolvedores/Contribuintes , como consigo aquele link?
Desde já grato.

Para conseguir o link da sua foto (essa que está usando no gitlab, por exemplo), basta clicar com o botão direito do mouse e clicar em Copiar link. Depois, pra que essa foto apareça nos aquivos .md, você deve colocar em um desses formatos:

Usando html:

<img src="https://avatars2.githubusercontent.com/u/46378210?s=400&u=071f7791bb03f8e102d835bdb9c2f0d3d24e8a34&v=4" width=115 />

Ou, no formato markdown

![](https://avatars2.githubusercontent.com/u/46378210?s=400&u=071f7791bb03f8e102d835bdb9c2f0d3d24e8a34&v=4)

Se tiver mais duvidas sobre os formatos, faça um fork desse gist e clique em editar, assim você vai conseguir ver como as coisas são formadas "por baixo dos panos"

Espero ter ajudado (:

excelente

Obrigado por disponibilizar esse template, ajudou bastante todos.

Muito bom, foi de grande ajuda.

Muito objetivo e bonito. Parabéns, Regina e obrigado por compartilhar!