From 754bc3d2aa48f078fc26486c1d021c0c566b0190 Mon Sep 17 00:00:00 2001
From: kevincaires <kevincaires@ymail.com>
Date: Fri, 19 Aug 2022 23:40:00 -0300
Subject: [PATCH] ADD simple README.md file.

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0a46348
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Neeble bot
+
+<img src="https://c.tenor.com/1HAl-cmOzswAAAAd/worms-meninblack.gif">
+
+---
+
+### Dependences
+
+- Python 3.8
+- gcc
+- python3-dev
+- libmysqlclient-dev or similar
+
+Or docker and docker-compose to run into container.
+
+---
+
+### How run
+
+- You need mysql instance running in your pc.
+- Into mysql instance create a db named `neeble`.
+- Copy file environment/template and rename then.
+- Fill environment variables into a new file.
+- Load environment varriables with source command
+> $ source environment/myenvfile
+
+##### Python local run
+- Execute `migrate` command to create necessary tables.
+> $ python manage.py migrate
+- Excecute `run` command.
+> $ python manage.py run
+
+##### Docker run
+- Execute the command:
+> $ docker-compose up -d --build