From: fennecdjay Date: Wed, 3 Jul 2019 14:52:39 +0000 (+0200) Subject: :art: Update docs X-Git-Tag: nightly~2381^2~6 X-Git-Url: http://10.10.0.4:5575/?a=commitdiff_plain;h=3994134452b5f8ad394ec076622a110447ec76ac;p=gwion.git :art: Update docs --- diff --git a/docs/01_Overview/00_First_Steps/01_InstallingGwion.mdr b/docs/01_Overview/00_First_Steps/01_InstallingGwion.mdr index 06fc544e..1e7717b2 100644 --- a/docs/01_Overview/00_First_Steps/01_InstallingGwion.mdr +++ b/docs/01_Overview/00_First_Steps/01_InstallingGwion.mdr @@ -23,7 +23,7 @@ git submodule update --init util ast ``` > At this point, you might want to configure the build. - In this case, have a look at the [configuration page](01_Overview/00_First_Steps/Configure.md) + In this case, have a look at the [configuration page](Configure.md) ## Build the libraries and program diff --git a/docs/BUILDING.mdr b/docs/BUILDING.mdr deleted file mode 100644 index 1babfe52..00000000 --- a/docs/BUILDING.mdr +++ /dev/null @@ -1,38 +0,0 @@ -# Build / Configure Gwion - -## Configure -### gwion-util - - * `USE_MEMCHECK`: compile with debug flags (`-g`) and enable asserts - * `USE_COVERAGE`: add coverage instrumentation - - -## Make -Basically, all that is left to do is -```sh -make -``` -The only environment variable affecting the operation is `PREFIX` - -Except `--(no-)double`, everything can be set when running make, -using environment variables. - -Drivers can be set on using, e.g. for *alsa* : `ALSA_D=1` or `ALSA_D=on`. -In the same way, then can be disabled with `ALSA_D=0` or `ALSA_D=off` - -### Running tests -```bash -make tests -``` -to run all tests, or -```bash -bash util/test.sh my_file_or_directory (.. other files/dirs ...) -``` -to run specific ones. -look [here](#testing.md) for more. -## Install -*maybe as root* -```sh -make install -``` -The only environment variable affecting the operation is `PREFIX` diff --git a/docs/Preprocessor.mdr b/docs/Preprocessor.mdr deleted file mode 100644 index e4e9d832..00000000 --- a/docs/Preprocessor.mdr +++ /dev/null @@ -1 +0,0 @@ -# Gwion Preprocessor diff --git a/docs/Testing.mdr b/docs/Testing.mdr deleted file mode 100644 index 3c3a79dd..00000000 --- a/docs/Testing.mdr +++ /dev/null @@ -1,28 +0,0 @@ -# Tests -[test.sh](https://github.com/fennecdjay/Gwion/blob/dev/util/test.sh) -requires [valgrind](http://valgrind.org/) -there are two kinds of tests: - * [gwion](#gwion-tests) - * [bash](#bash-tests) - -## Gwion tests -those tests are just gwion (.gw) files, handling special comments: - * `// [skip]` (*optionally* followed by reason to skip) - * `// [todo]` (*optionally* followed by reason to delay testing) - * `// [contains]` followed by string to match - * `// [excludes]` followed by string not to match - -## Shell test -those tests are just bash (.sh) files. -they should start with this snippet -```bash -#!/bin/bash -# [test] #5 -n=0 -[ "$1" ] && n="$1" -[ "$n" -eq 0 ] && n=1 -source tests/sh/common.sh -``` - -## TODO - [ ] `bailout` system for early exit on failure diff --git a/docs/assets/benchmark/binary-trees.dat b/docs/assets/benchmark/binary-trees.dat index 6b1f8faa..2cd7956a 100644 --- a/docs/assets/benchmark/binary-trees.dat +++ b/docs/assets/benchmark/binary-trees.dat @@ -1,3 +1,3 @@ -gwion 0.186408 0.33 -wren 0.230839 0.18 -lua 0.304600 0.24 +gwion 0.19202 0.54 +wren 0.239317 0.22 +lua 0.32971 1.33 diff --git a/docs/assets/benchmark/binary-trees.png b/docs/assets/benchmark/binary-trees.png index fb261d56..109747f5 100644 Binary files a/docs/assets/benchmark/binary-trees.png and b/docs/assets/benchmark/binary-trees.png differ diff --git a/docs/assets/benchmark/fib-recurs.dat b/docs/assets/benchmark/fib-recurs.dat index 0e5f0c83..86f9eb6e 100644 --- a/docs/assets/benchmark/fib-recurs.dat +++ b/docs/assets/benchmark/fib-recurs.dat @@ -1,3 +1,3 @@ -gwion 5.3602 0.76 -wren 13.7710 0.54 -lua 7.5633 0.92 +gwion 5.3284 0.22 +wren 13.7413 0.56 +lua 7.5237 0.31 diff --git a/docs/assets/benchmark/fib-recurs.png b/docs/assets/benchmark/fib-recurs.png index 837be4b0..5ee19f84 100644 Binary files a/docs/assets/benchmark/fib-recurs.png and b/docs/assets/benchmark/fib-recurs.png differ diff --git a/docs/assets/benchmark/fib.dat b/docs/assets/benchmark/fib.dat index 7c079271..3247b482 100644 --- a/docs/assets/benchmark/fib.dat +++ b/docs/assets/benchmark/fib.dat @@ -1,3 +1,3 @@ -gwion 0.085051 0.65 -wren 0.212702 0.17 -lua 0.21245 0.69 +gwion 0.086983 0.46 +wren 0.21537 0.82 +lua 0.21401 0.71 diff --git a/docs/assets/benchmark/fib.png b/docs/assets/benchmark/fib.png index 899201fd..758382a0 100644 Binary files a/docs/assets/benchmark/fib.png and b/docs/assets/benchmark/fib.png differ diff --git a/docs/assets/benchmark/method-call.dat b/docs/assets/benchmark/method-call.dat index 539c489e..a1f473c0 100644 --- a/docs/assets/benchmark/method-call.dat +++ b/docs/assets/benchmark/method-call.dat @@ -1,3 +1,3 @@ -gwion 0.095307 0.31 -wren 0.111192 0.41 -lua 0.26047 1.04 +gwion 0.092774 0.34 +wren 0.110397 0.41 +lua 0.25987 1.67 diff --git a/docs/assets/benchmark/method-call.png b/docs/assets/benchmark/method-call.png index ce6a9734..d4918073 100644 Binary files a/docs/assets/benchmark/method-call.png and b/docs/assets/benchmark/method-call.png differ