aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md
index 09b5881..9ecd744 100644
--- a/README.md
+++ b/README.md
@@ -61,7 +61,7 @@ The results of the last test case run is saved in test/last.out (standard
61output, the results compared with the .out files) and test/last.err 61output, the results compared with the .out files) and test/last.err
62(standard error). 62(standard error).
63 63
64Tests are always run in "debug mode": this means that optimizations are 64Tests are always run in debug mode: this means that optimizations are
65disabled and some extra logging is enabled. 65disabled and some extra logging is enabled.
66 66
67See the test folder and test/test.sh for details. 67See the test folder and test/test.sh for details.
@@ -70,7 +70,7 @@ See the test folder and test/test.sh for details.
70 70
71In the tools folder there are some small programs that test various 71In the tools folder there are some small programs that test various
72functionality of the H48 library. They work similarly to test, but they 72functionality of the H48 library. They work similarly to test, but they
73are not run in debug mode. 73are not run in debug mode by default.
74 74
75To run a tool you must select it with the environment variable `TOOL`. 75To run a tool you must select it with the environment variable `TOOL`.
76For example the command: 76For example the command:
@@ -79,14 +79,26 @@ For example the command:
79TOOL=stats make tool 79TOOL=stats make tool
80``` 80```
81 81
82Will run the stats_tables_h48 tool. Like for tests, the value of the 82Will run the stats_tables_h48 tool.
83`TOOL` variable can be any regular expression matching the name of the 83
84tool. Unlike tests, one and only one tool will be selected for each run. 84To pass some arguments to a tool, use the `TOOLARGS` variable:
85
86```
87TOOL=gendata TOOLARGS="h48 0;2;20" make tool
88```
89
90Like for tests, the value of the `TOOL` variable can be any regular
91expression matching the name of the tool. Unlike tests, one and
92only one tool will be selected for each run. The content of the
93`TOOLARGS` variable is used directly as command line arguments for
94the chosen tool.
85 95
86Each tool run is automatically timed, so these tools can be used as 96Each tool run is automatically timed, so these tools can be used as
87benchmark. The output as well as the time of the run are saved to a 97benchmark. The output as well as the time of the run are saved to a
88file in the tools/results folder. 98file in the tools/results folder.
89 99
100To build and run a tool in debug mode, use `make debugtool`.
101
90## Running commands manually 102## Running commands manually
91 103
92This project also includes a rudimentary shell that can be used to run 104This project also includes a rudimentary shell that can be used to run

Generated with cgit - Back to sebastiano.tronto.net