From 61c54b1703a1919476835dce6882bcc3241a3218 Mon Sep 17 00:00:00 2001 From: Amber <63863236+amberisvibin@users.noreply.github.com> Date: Mon, 21 Sep 2020 15:00:37 -0400 Subject: [PATCH] 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] --- docs/Overview/First_Steps/Configure.mdr | 27 ++++++++++--------- docs/Overview/First_Steps/InstallingGwion.mdr | 4 ++- docs/Overview/First_Steps/README.mdr | 2 ++ docs/Overview/First_Steps/list | 2 +- docs/Overview/README.mdr | 2 ++ 5 files changed, 23 insertions(+), 14 deletions(-) diff --git a/docs/Overview/First_Steps/Configure.mdr b/docs/Overview/First_Steps/Configure.mdr index b05d398b..a4283a73 100644 --- 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 b5350f24..7f7b4da5 100644 --- 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 3790de05..fb46499b 100644 --- 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 9968b7cc..3f7039d8 100644 --- 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 3b158d40..f9217f93 100644 --- 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. + -- 2.43.0