README.md

Me Adota - Documentations

This is the general documentation for Me Adota website.
It runs on MKDocs.
Versão em PT-BR aqui.

---

Requirements

You must have Python 3.8, Pip 20.2 and virtualenv installed on your machine.

Installing and Running

1. Clone the repository

$ git clone https://github.com/Me-Adota/docs.git

2. Access the repository directory

$ cd docs

3. You must activate the venv bin, it will be activated using

$ virtualenv venv

$ source venv/bin/activate

4. The requirements.txt file should list all Python libraries that your machine depend on, and they will be installed using

$ pip install -r requirements.txt

5. Run

$ mkdocs serve

Done! It should be running on: http://127.0.0.1:8000/

---

LICENSE

This project is licensed under the MIT LICENSE, read more in LICENSE.md.