Nome_da_Aplicação é um/uma ... que permite/tem por objetivo/visa/etc ....
Coloque aqui linhas adicionais com informações sobre o que a aplicação faz. Sua introdução deve ser de no máximo 3 parágrafos, seja simples e objetivo para não sobrecarregar de detalhes desnecessários este espaço. Se necessário, crie novas seções abaixo.
Antes de iniciar, certifique-se de cumprir os seguintes requisitos:
- Você deve possuir a última versão do
<linguagem/dependencia/etc>
instalado. - Você deve possuir uma máquina
<Windows/Linux/Mac>
. (Deixe claro qual SO é possível rodar a aplicação, Linux é obrigatório). - Você deve ler o
<guia/link/documentação>
dos termos de uso. - (outros ...)
Para fazer o deploy da aplicação siga os seguintes passos:
Linux e/ou macOS:
<commando 1>
<commando 2>
....
<commando n>
Windows (opcional):
<commandos>
Para usar Nome_da_Aplicação, siga os seguintes passos (exemplos):
- Abra o navegador e digite o seguinte endereço:
http://localhost/....
- Ao abrir a aplicação você poderá:
- Navegar pelo conteúdo público, ou
- Entrar com usuário e senha para ....
- Continua ...
Descreva as principais atividades, e/ou fluxos, que são possíveis de serem realizadas na aplicação.
As seguintes pessoas contribuiram para este projeto:
- Meu nome
- .... (liste todos os membros da equipe)
Este projeto usa a seguinte licença: <nome_da_licenca>. Você também deve criar um arquivo chamado LICENSE no projeto