Template para Read.md

Modelo de template para documentação de projetos no GitHub, cujo objetivo é listar todos os recursos do Markdown (linguagem de marcação).

Com o Markdown é possível facilmente exibir cabeçalhos ou ter palavras em itálico, ou negrito ou quase tudo o que pode ser feito para o texto.

É importante quando você quer publicar seu projeto e chamar a atenção da comunidade, alguns tópicos importantes:

• Instalação
• Requisitos
• Resumo do que é
• Resumo para que serve
• Vantagens
• Desvantegens
• Exemplos de uso simples
• Exemplos de uso personalizado

É importante que essa parte seja completa e atrativa porém evite algo muito longo (não será este caso).

---

Título

Aqui vem um parágrafo com resumo do que é o seu projeto

Aqui vem um parágrafo com resumo de para que serve o seu projeto

Autores:

Informe aqui quem participou do projeto e quais foram suas responsabilidades e funções

• Fulano - Desenvolvedor Frontend;
• Ciclano - Desenvolvedor Backend;
• Beltrano - Ajudou muito não atrapalhando

Primeiros Passos:

Insira aqui as instruções de como conseguir uma cópia do projeto e de como rodar o mesmo na máquina local para propósitos de desenvolvimento e testes

Requisitos do sistema:

• Linguagem de programação utilizada acompanhada de sua versão;
• Framework 1
• Framework 2
• Banco de dados
• Demais tecnologias

Imagem demonstrando o sistema funcionando corretamente

Instalção:

Explique o passo a passo da instalação com exemplos e também explique como fazer para rodar o ambiente virtual.

1. Descreva da primeira etapa:

Dê o exemplo

2. Até a última etapa:

até terminar

Executando os testes:

Explique como executar os testes automatizados para o seu programa

Ferramentas utilizadas

Informe aqui as ferramentas utilizadas para o desenvolvimento do projeto

• Visual Studio Code
• Google Chrome
• Gimp

Extras:

Aqui há alguns elementos do markdown não utilizado no tutorial acima

Código:

# Python 3: Fibonacci series up to n
>>> def fib(n):
>>>     a, b = 0, 1
>>>     while a < n:
>>>         print(a, end=' ')
>>>         a, b = b, a+b
>>>     print()
>>> fib(1000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987

Tabelas:

ID	Nome	Função
1	John Lennon	Vocal/Guitarrista
2	Paul Mccartney	Vocal/Baixista
3	George Harrison	Vocal/Guitarrista
4	Ringo Starr	Vocal/Baterista

Lista de tarefas:

• Levantamento de requisitos
• Criação do template
• Publicar na página do projeto
• Dominar o mundo

Tamanho do texto:

Tamnho h4

Tamanho h5

Tamanho h6

Fonte: Raul Esteves