Update `Configure.mdr` to new build system, etc. (#9)

* undo re-arrange of install and config in first steps [skip benchmark]

* add info to install page [skip benchmark]

* Update configgwion, installgwion, FSREADME [skip benchmark]

* Add unknowns to configtutorial [skip benchmark]

diff --git a/docs/Overview/First_Steps/Configure.mdr b/docs/Overview/First_Steps/Configure.mdr
index b05d398b3f803e47f645481b6d0528d6cfe97fae..a4283a73683a4d93c8f97e46e9cc3e7c3584b931 100644 (file)
--- a/docs/Overview/First_Steps/Configure.mdr
+++ b/docs/Overview/First_Steps/Configure.mdr
@@ -1,18 +1,21 @@
 # Configuring Gwion
 
-## util/config.mk
+Gwion can be configured to better suit the user's needs. This is mainly done in two files: `config.mk` and `util/config.mk`.
 
-double
+## `config.mk`
 
-gettext
+- `DEBUG_STACK  ?= 0`
+  - Enables the debug stack, which prints some stack info, thus verifying whether a function is balanced.
 
-memcheck
+## `util/config.mk`
 
-lto
-
-coverage
-
-## ast/config.mk
-
-## config.mk
-Here are a few choices left
+- `USE_DOUBLE   ?= 0`
+  - Sets the size of float to double
+- `USE_GETTEXT  ?= 0`
+  - Enable internationalization (almost complete)
+- `USE_DEBUG    ?= 1`
+  - Enables debug features
+- `USE_LTO      ?= 0`
+  - Enables Link-Time Optimization
+- `USE_COVERAGE ?= 0`
+  - Enables code coverage

diff --git a/docs/Overview/First_Steps/InstallingGwion.mdr b/docs/Overview/First_Steps/InstallingGwion.mdr
index b5350f24663eea2847f8f3411fb2295f2b2ed94c..7f7b4da5d17c17db865f3097eb4aeca9f86f95ed 100644 (file)
--- a/docs/Overview/First_Steps/InstallingGwion.mdr
+++ b/docs/Overview/First_Steps/InstallingGwion.mdr
@@ -23,7 +23,7 @@ git submodule update --init util ast
 ```
 
 > At this point, you may want to configure the build.
-  In this case, have a look at the [configuration page](Configure.md)
+  In this case, have a look at the [configuration page](Configure.md).
 
 
 ## Build the libraries and program
@@ -38,3 +38,5 @@ make install
 ```
 
 > You may need root privilege to do this.
+
+> This is not *strictly* necessary, as you can run the program by typing `./gwion` in the `gwion` directory. It is a good idea to install it, however, so that it can be run in any folder on the system.

diff --git a/docs/Overview/First_Steps/README.mdr b/docs/Overview/First_Steps/README.mdr
index 3790de05974f7ac4b8fd11d76ce2f4735d68053b..fb46499b730fb4e17d473b1bb9bda4af4f1403e7 100644 (file)
--- a/docs/Overview/First_Steps/README.mdr
+++ b/docs/Overview/First_Steps/README.mdr
@@ -1 +1,3 @@
 # First Steps
+
+This guide will help you install Gwion.
\ No newline at end of file

diff --git a/docs/Overview/First_Steps/list b/docs/Overview/First_Steps/list
index 9968b7ccbb06e1efad828f0ce686ec4b324ae9a3..3f7039d8f3f8f150c58ae2d981f624cae783f20d 100644 (file)
--- a/docs/Overview/First_Steps/list
+++ b/docs/Overview/First_Steps/list
@@ -1,3 +1,3 @@
 README.md
-Configure.md
 InstallingGwion.md
+Configure.md

diff --git a/docs/Overview/README.mdr b/docs/Overview/README.mdr
index 3b158d400d9c05e97fc45f9c4a23e32ee7af7d4b..f9217f938c8bc998467e3287ec5f36344163b96b 100644 (file)
--- a/docs/Overview/README.mdr
+++ b/docs/Overview/README.mdr
@@ -1,3 +1,5 @@
 # Overview
 
+This is a basic tutorial that will lead you through the basics of Gwion.
+
 <!-- toc -->