From 62cfaa3061979a800ff379c10bf310bf45758239 Mon Sep 17 00:00:00 2001
From: fennecdjay <astor.jeremie@wanadoo.fr>
Date: Thu, 20 Jun 2019 17:32:49 +0200
Subject: [PATCH] :book: README

---
 README.md                                     | 39 ++++++++++++++++---
 docs/01_Overview/00_First_Steps/Configure.mdr | 17 ++++++++
 2 files changed, 51 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 54f30ac9..09cbefb8 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ gwion is a object-oriented programming language, aimed at making music
 
 :gift: a [plugin system](https://github.com/fennecdjay/Gwion-plug) makes it easily extendable
 
-#### simple example code (hello_world.gw):
+### simple example code (hello_world.gw):
 
 ```cpp
 // print hello world
@@ -25,15 +25,44 @@ to run this, do
 You want to know more? :smile: Look [here](https://fennecdjay.github.io/gwion/)
 Still WIP :construction_worker: but a nice place to learn and [contribute](https://github.com/fennecdjay/gwion/issues)
 
-#### build
-just
+## Build
+### Download the source
+This project makes use of submodules, so you can clone it with
+``` sh
+git clone --recursive https://github.com/fennecdjay/Gwion
+```
+or if you just want the minimum to start with, try
+``` sh
+git clone https://github.com/fennecdjay/Gwion
+git submodule update --init util ast
+```
+
+You can now move to the source directory
+``` sh
+cd Gwion
+```
+
+### Configure (optionnal)
+You might want to make sure every compile-time option is set to your liking.
+First list the files that set those.
+``` sh
+find . -name "config.mk"
+```
+You can now edit then to your preference.
+
+> Besides develloper options, the most important one is *USE_DOUBLE*, in util/config.mk, which set the floating point size (float or double).
+
+### Compiling
+
 ```
 make
 ```
 
-> if you run into troubles, please look [here](https://github.com/fennecdjay/Gwion/blob/master/docs/Building.md) and read on.
+### Other make targets
+Other basic targets include: clean install uninstall test
+
 
-#### Reporting bugs / Contributing
+## Reporting bugs / Contributing
 
 :+1: Every helping hand is welcome!!! :+1:  
 :book: Please see the [contributing](.github/CONTRIBUTING.md) page for more information.
diff --git a/docs/01_Overview/00_First_Steps/Configure.mdr b/docs/01_Overview/00_First_Steps/Configure.mdr
index 8e411fc9..b05d398b 100644
--- a/docs/01_Overview/00_First_Steps/Configure.mdr
+++ b/docs/01_Overview/00_First_Steps/Configure.mdr
@@ -1 +1,18 @@
 # Configuring Gwion
+
+## util/config.mk
+
+double
+
+gettext
+
+memcheck
+
+lto
+
+coverage
+
+## ast/config.mk
+
+## config.mk
+Here are a few choices left
-- 
2.43.0