A5.1

_explicacoes/a5.1.md

@@ -0,0 +1,25 @@
+## A5.1: Documentando nosso projeto: Badges, Markdown e usabilidade de documentos
+
+- Estilos de Documento:
+  - README.md
+    - [Exemplo](../docs/README.md)
+  - RFC: Request for Comments
+    - https://docs.google.com/document/d/1eUzLZekVbk_qynNDoG3CX6jN2vyNjw53pa5dncJ_ucs/edit#heading=h.irgarncgzpz0
+  - DR: Decision Record
+    - Título (2024/Q2 - ...)
+    - Contexto
+    - Decisão
+    - Motivação
+    - Alternativas Consideradas
+    - Consequências
+    - Data
+    - RACI (Responsável, Aprovador, Consultado, Informado)
+
+- Formas de escrever:
+  - Markdown: https://docs.github.com/pt/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
+- Recursos Interessantes
+  - Badges
+    - https://shields.io/
+  - Diagramas
+    - ???

docs/README.md

@@ -0,0 +1,47 @@
+# Projet Name
+
+> Small description
+
+## About this project 📚
+
+Context...
+
+## Setup & Run 🚀
+
+### Pre-requisites
+
+- [NodeJS](https://nodejs.org/en/), last version LTS
+
+### Setup
+
+Install dependencies with npm
+
+```sh
+npm ci
+```
+
+### Build
+
+```sh
+npm run build
+```
+
+> Extra considerations about the build?
+
+## Running Tests ⚗️
+
+Running all tests
+
+```sh
+npm run test # runs all tests
+```
+
+```sh
+npm run test-changed # runs only changed tests
+```
+
+## Running Lint ✨
+
+```sh
+npm run lint
+```