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

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!