]> Nishi Git Mirror - gwion.git/commitdiff
:art: Update docs
authorfennecdjay <astor.jeremie@wanadoo.fr>
Wed, 3 Jul 2019 14:52:39 +0000 (16:52 +0200)
committerfennecdjay <astor.jeremie@wanadoo.fr>
Wed, 3 Jul 2019 14:52:39 +0000 (16:52 +0200)
12 files changed:
docs/01_Overview/00_First_Steps/01_InstallingGwion.mdr
docs/BUILDING.mdr [deleted file]
docs/Preprocessor.mdr [deleted file]
docs/Testing.mdr [deleted file]
docs/assets/benchmark/binary-trees.dat
docs/assets/benchmark/binary-trees.png
docs/assets/benchmark/fib-recurs.dat
docs/assets/benchmark/fib-recurs.png
docs/assets/benchmark/fib.dat
docs/assets/benchmark/fib.png
docs/assets/benchmark/method-call.dat
docs/assets/benchmark/method-call.png

index 06fc544efd06e2b2c210d5738fd51deaa576606e..1e7717b201450647b69db8c4af04e3e025a067d5 100644 (file)
@@ -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 (file)
index 1babfe5..0000000
+++ /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 (file)
index e4e9d83..0000000
+++ /dev/null
@@ -1 +0,0 @@
-# Gwion Preprocessor
diff --git a/docs/Testing.mdr b/docs/Testing.mdr
deleted file mode 100644 (file)
index 3c3a79d..0000000
+++ /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
index 6b1f8faa1b5c9e286e33c7357d9627ce36e3f285..2cd7956a2e6c26f9da0e8d6d727f23787b392f37 100644 (file)
@@ -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
index fb261d560b834315d0a5511ffd1b356cb1f98437..109747f5cdf036bc3d63cc0c3eebefe87c4bc73c 100644 (file)
Binary files a/docs/assets/benchmark/binary-trees.png and b/docs/assets/benchmark/binary-trees.png differ
index 0e5f0c83a380afc263c3757b809d376988663b0c..86f9eb6e77e54a3d0adf47bfb2f9a3d35f8105bd 100644 (file)
@@ -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
index 837be4b0789e51c3ef0d4e86b623a7ddf4564b97..5ee19f84361fdc7908609103777004efd7904dea 100644 (file)
Binary files a/docs/assets/benchmark/fib-recurs.png and b/docs/assets/benchmark/fib-recurs.png differ
index 7c079271dcf1025ca1c9c496c736aa45e710b79d..3247b482cabe6d3dfe17fd7a6be6f3cedc1ccf48 100644 (file)
@@ -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
index 899201fd9bf126d434ce277889ce3b9dfda2d9fc..758382a026b901e8fd423bfc75fabc81a2c7ffbe 100644 (file)
Binary files a/docs/assets/benchmark/fib.png and b/docs/assets/benchmark/fib.png differ
index 539c489e08dd71e6f7111d3d23fb179188d81c20..a1f473c0a2a0800bb7f5a2a5fb4d4ee14a62e26c 100644 (file)
@@ -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
index ce6a9734c2a538774af81096c3ec4ced9c4e23b1..d4918073927219a1dac80a9b67c48c7049730ad9 100644 (file)
Binary files a/docs/assets/benchmark/method-call.png and b/docs/assets/benchmark/method-call.png differ