Modelo 1 de README para repositórios do GitHub

README.md

Nome do projeto

📃 Roteiro

• 📱 Versão Mobile
• 🖥️ Versão Desktop
• ❓ Sobre
• 🛠️ Tecnologias
• 📋 Pré-requisitos
• 🚀 Requisitos
  • Requisitos Funcionais
  • Regras de Negócio
  • Requisitos Não Funcionais
• 🔧 Instalação
• ⚙️ Executando
• 🔖 Layout
• 🌐 Deploy
• 🧑‍💻 Autor
• 📝 Licença

📱 Versão Mobile

🖥️ Versão Desktop

❓ Sobre

Linha adicional de texto informativo sobre o que o projeto faz.

🛠️ Tecnologias

O projeto foi desenvolvido com as seguintes tecnologias:

• Tecnologia 1
• Tecnologia 2
• Tecnologia 3

🚀 Requisitos

Requisitos Funcionais

• ✅ Requisito 1
• ✅ Requisito 2
• ✅ Requisito 3

Regras de Negócio

• ✅ Requisito 1
• ✅ Requisito 2
• ✅ Requisito 3

Requisitos Não Funcionais

• ✅ Requisito 1
• ✅ Requisito 2
• ✅ Requisito 3

📋 Pré-requisitos

Verifique aos seguintes pré-requisitos para poder instalar e executar o projeto:

1. Ter instalado um editor de código: VS Code
2. Ter instalado o Git
3. Ter instalado a extensão Live Server

🔧 Instalação

Siga o passo a passo para instalar o projeto:

1. Abra o terminal e clone o repositório do projeto:

git clone https://github.com/nome-de-usuario-no-github/nome-do-repositorio-no-github

⚙️ Executando

Siga o passo a passo para executar o projeto:

1. Entre na pasta do projeto clonado:

cd nome-da-pasta-do-projeto-clonado

2. Abra a pasta do projeto clonado no editor de código de sua preferência. Caso seja o VS Code digite o comando:

code .

3. Abra o arquivo index.html com a extensão Live Server do VS Code

🔖 Layout

Visualize o layout do projeto através DESSE LINK. É necessário ter conta no Figma para acessá-lo.

🌐 Deploy

• Exibir projeto

🧑‍💻 Autor

Pedro Euzebio

📝 Licença

O projeto está sob licença MIT. Veja o arquivo LICENSE para mais detalhes.