Merge pull request #26 from unb-mds/feat/docs

docs(readme): descreve o projeto e como inicializa

README.md

@@ -1 +1,46 @@
-# 2023-2-Squad11
+# Sua Grade UnB
+
+O Sua Grade UnB é um projeto em desenvolvimento da matéria **Métodos de Desenvolvimento de Software**, a qual tem como objetivo auxiliar os alunos da Universidade de Brasília a montarem suas grades horárias de forma mais fácil e intuitiva.
+
+## ✨ Início
+
+Você pode clonar o repositório do projeto com o seguinte comando:
+
+```bash
+git clone https://github.com/unb-mds/2023-2-Squad11.git
+```
+
+### Dependências globais
+
+Para rodar o projeto, você precisa instalar as dependências globais, que são:
+
+- Python v3.11 (ou superior)
+- Docker Engine v24.0.6 and Docker Compose v2.21.0 (or greater)
+
+### Ambiente
+
+Para configurar o ambiente, você pode rodar o seguinte script:
+
+```bash
+bash ./scripts/env.sh
+```
+
+### Execução
+
+Para executar o projeto, você pode rodar o seguinte comando:
+
+```bash
+docker compose up
+```
+
+### Migrations
+
+Para criar possíveis novas migrations, você pode rodar o seguinte comando:
+
+```bash
+python3 ./api/manage.py makemigrations --settings=core.settings.dev
+```
+
+## 📚 Documentação
+
+A documentação do projeto pode ser encontrada na pasta [docs](https://unb-mds.github.io/2023-2-Squad11/).