feat: adicionando readme

README.md

@@ -1,2 +1,72 @@
-# 2024.2-T03-CafeDoSitio
-Repositório de projeto da disciplina de REQ-T3.
+# [T03/2024.2] Cafe Do Sitio |☕| Requisitados
+
+![Banner](./docs/assets/CafeSitioBanner.png)
+
+<center>
+
+![GitHub repo size](https://img.shields.io/github/repo-size/mdsreq-fga-unb/2024.2-T03-CafeDoSitio?style=for-the-badge)
+![GitHub issues](https://img.shields.io/github/issues/mdsreq-fga-unb/2024.2-T03-CafeDoSitio?style=for-the-badge)
+![GitHub views](https://komarev.com/ghpvc/?username=req-fga-unb&repo=2024.2-T03-CafeDoSitio&color=blueviolet&style=for-the-badge&label=Views)
+
+</center>
+
+<br>
+<br>
+<br>
+
+<center>
+<h1> Seja bem-vindo à Documentação do Projeto! 👋</h1>
+</center>
+
+Este é o repositório do projeto da disciplina de REQ-T3 para o semestre 2024.2. Aqui você encontrará toda as instruções necessária para entender e contribuir para a documentação do projeto.
+
+<br>
+
+### 1. Sobre a Documentação:
+Nossa documentação é mantida separadamente da branch principal (main) e é gerenciada utilizando o MkDocs, uma ferramenta popular para criação de documentação estática a partir de arquivos Markdown. Utilizamos o tema "Material" para proporcionar uma experiência de leitura limpa e moderna.
+
+### 2. Instalando as Dependências do Docs:
+Antes de começar a explorar a documentação, é necessário instalar as dependências do MkDocs e configurar o ambiente local. Siga os passos abaixo:
+
+### 3. Instale o MkDocs:
+Certifique-se de ter o MkDocs instalado. Se ainda não o tiver, você pode instalá-lo utilizando pip, o gerenciador de pacotes do Python:
+
+No Ubuntu:
+
+```shell
+sudo apt install mkdocs
+```
+
+Com pip (funciona no Windows ou Linux):
+```shell
+pip install mkdocs
+```
+
+### 4. Instale o Tema "Material":
+O tema "Material" é utilizado para fornecer uma experiência de documentação limpa e responsiva. Instale-o usando pip:
+
+Com pip (É necessário ter pip, no Windows e no Linux)
+```shell
+pip install mkdocs-material
+```
+
+### 5. Clonando o Repositório da Documentação (Se não tiver Clonado):
+Clone a branch de documentação para obter os arquivos MkDocs necessários:
+
+```shell
+git clone -b documentacao https://github.com/mdsreq-fga-unb/2024.2-T03-CafeDoSitio.git
+```
+
+### 6. Visualize a Documentação Localmente:
+Por fim, inicie o servidor de desenvolvimento MkDocs para visualizar a documentação localmente em seu navegador:
+
+```shell
+mkdocs serve
+```
+
+Isso iniciará um servidor local em http://localhost:8000, onde você poderá visualizar a documentação. Qualquer alteração nos arquivos Markdown será automaticamente refletida na visualização do navegador.
+
+<br>
+<br>
+
+Agora que você configurou seu ambiente de desenvolvimento local, você está pronto para explorar nossa documentação e contribuir para o projeto. Se tiver alguma dúvida ou encontrar algum problema, não hesite em entrar em contato conosco. Agradecemos sua contribuição e interesse em nosso projeto!