search

rosaigor138 / project_college

The first step of a college project
0 stars 0 forks source link

Adicionar README #7

Open LBeghini opened 2 years ago

LBeghini commented 2 years ago

Em projetos do GitHub, o README se faz muito importante, por ser nele onde qualquer pessoa irá buscar informações sobre do que se trata o trabalho.

Dessa forma, fazer um README com as informações do projeto.

Sugerstão de Template

# Titulo do Projeto
Descrição do projeto. Porque foi feito.

## Tecnologias
- lista
- as
- tecnologias
- utilizadas

## Requisitos
O  que é preciso ter instalado para rodar o projeto?
- lista
- do 
- que 
- precisa

## Executar
O que preciso fazer para executar o projeto?

1. Pode ser um passo a passo
2. Pode ser texto corrido

> Lembrando que: nem todo mundo usa a mesma IDE que você, mas todo mundo definitivamente tem um console! Então é sempre recomendado indicar como executa o projeto utilizando o CMD

## Testes

Como roda os testes?
1. Pode ser um passo a passo
2. Pode ser texto corrido

> Lembrando que: nem todo mundo usa a mesma IDE que você, mas todo mundo definitivamente tem um console! Então é sempre recomendado indicar como executa o projeto utilizando o CMD

💅 Enfeite como quiser!

Utilize-se de emojis, formatação HTML, outros recursos de Markdown para que seu README seja o mais amigável possível! Lembrando-se que: nunca deixe de prezar que seu texto seja legível.

Aqui tem várias sugestões de README que podem ser utilizadas como exemplo.

LBeghini commented 2 years ago

Se precisar de ajuda na escrita da parte de como executar por linha de comando, pode me chamar!