From 27f820392b4441d212e749e5dc9184529b3ab38e Mon Sep 17 00:00:00 2001
From: RignonNoel <rignon.noel@gmail.com>
Date: Fri, 2 Feb 2018 11:10:17 -0500
Subject: [PATCH] add ReadTheDoc on the repository

---
 docs/Create_a_map.md | 14 +++++++++++++
 docs/Quickstart.md   | 47 ++++++++++++++++++++++++++++++++++++++++++++
 docs/index.md        |  8 ++++++++
 3 files changed, 69 insertions(+)
 create mode 100644 docs/Create_a_map.md
 create mode 100644 docs/Quickstart.md
 create mode 100644 docs/index.md

diff --git a/docs/Create_a_map.md b/docs/Create_a_map.md
new file mode 100644
index 0000000..3569f72
--- /dev/null
+++ b/docs/Create_a_map.md
@@ -0,0 +1,14 @@
+**How to create a map** 
+
+This game engine allow you to import map 
+from [Tiled](http://www.mapeditor.org/), a 
+really good and easy to use map editor.
+
+![Screenshot 2DMaker](../static/screenshot2.png)
+
+
+**Our map manager allow you to:**
+
+ - Import TMX file create from [Tiled](http://www.mapeditor.org/)
+ - Manage multiple depth of layouts
+ - Manage multiple tileset's image
diff --git a/docs/Quickstart.md b/docs/Quickstart.md
new file mode 100644
index 0000000..9ae1c5b
--- /dev/null
+++ b/docs/Quickstart.md
@@ -0,0 +1,47 @@
+# Quickstart
+
+## Clone the project
+
+The project use [Git](https://git-scm.com/) and is accessible on [Github](https://github.com/).
+
+First of all you need to clone the project on your computer.
+
+```
+git clone https://github.com/RignonNoel/2DMaker.git
+```
+
+## Create a virtual environment
+
+[Virtualenv](https://virtualenv.pypa.io/) provide isolated Python environments, which are more practical than installing packages systemwide. They also allow installing packages without administrator privileges.
+
+1. Create a new virtual environment 
+```
+virtualenv env
+```
+
+2. Active the virtual environment
+
+```
+. env/bin/activate
+```
+
+You need to ensure the virtual environment is active each time you want to launch the project.
+
+## Install all requirements
+
+All requirements used by this projects are documented inside the `requirements.txt` file at the root of the repository.
+You can install all requirements needed by just one commandline.
+
+**WARNING** : Make sure your virtual environment is active or you will install all these packages systemwide. 
+```
+pip install -r requirements.txt
+```
+ 
+## Test the installation
+
+To launch a first test of this POC you just 
+need to execute this commandline
+
+```python
+python src/main.py
+```
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..966d641
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,8 @@
+**2DMaker** 
+
+Really little 2D Game Engine write in python.
+
+The actual state of development is more a proof of concept 
+using Entity-Component-System paradigm.
+
+![Screenshot 2DMaker](../static/screenshot.png)
\ No newline at end of file