]> Nishi Git Mirror - gwion.git/commitdiff
:book: README
authorfennecdjay <astor.jeremie@wanadoo.fr>
Thu, 20 Jun 2019 15:32:49 +0000 (17:32 +0200)
committerfennecdjay <astor.jeremie@wanadoo.fr>
Thu, 20 Jun 2019 15:32:49 +0000 (17:32 +0200)
README.md
docs/01_Overview/00_First_Steps/Configure.mdr

index 54f30ac94e016279b9ff559d226f0b304b5e828d..09cbefb8bc73a1a8c49485526cd2a92a9ffe29e9 100644 (file)
--- 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.
index 8e411fc9906f8d61512a2b9a56926f1eaaec1271..b05d398b3f803e47f645481b6d0528d6cfe97fae 100644 (file)
@@ -1 +1,18 @@
 # Configuring Gwion
+
+## util/config.mk
+
+double
+
+gettext
+
+memcheck
+
+lto
+
+coverage
+
+## ast/config.mk
+
+## config.mk
+Here are a few choices left