Editar Documentação e adicionar métricas do projeto - Githubissues

unb-mds / 2023-2-Squad05-TesouroMineiro

https://unb-mds.github.io/2023-2-Squad05-TesouroMineiro/

https://tesouromineiro.vercel.app/

MIT License

4 stars 2 forks source link

Editar Documentação e adicionar métricas do projeto #71

Closed EliasOliver21 closed 7 months ago

EliasOliver21 commented 8 months ago

Descrição

Trabalhando na documentação do projeto.

Objetivo

O objetivo dessa issue é atualizar e aprimorar a documentação do projeto.

Pontos Importantes

[x] Atualizar o Readme para responder todas as dúvidas.
[x] Adicionar nova imagem do fluxo de processamento.
[x] Adicionar badges-stats no Readme.
[x] Adicionar comandos para a executador o frontend localmente.

Critérios de Aceitação

[x] As informações estão de acordo com o projeto atual.
[x] A imagem está de acordo com as ferramentas utilizadas.
[x] Os basges-stats estão funcianando corretamente.
[x] É possivel executar o frontend com os comandos apresentados.

claudiohsc commented 8 months ago

Tentar focar o Readme orientado a responder "o quê", "o porquê" e o "como" relativos ao projeto.

IderlanJ commented 7 months ago

Tentar focar o Readme orientado a responder "o quê", "o porquê" e o "como" relativos ao projeto.

Ok, farei isso.

claudiohsc commented 7 months ago

Depois, só alinhar os títulos.