1.1 --- a/README.txt Sun Nov 29 01:46:46 2009 +0100
1.2 +++ b/README.txt Sun Nov 29 01:51:09 2009 +0100
1.3 @@ -15,9 +15,10 @@
1.4 -----------
1.5
1.6 Currently, the test.py program is the principal means of compiling and running
1.7 -code. For example, to inspect the logical.py test program...
1.8 +code. For example, to inspect the logical.py test program (with all
1.9 +optimisations enabled)...
1.10
1.11 - python -i test.py tests/logical.py -m
1.12 + python -i test.py tests/logical.py -m -omax
1.13
1.14 ...will provide a number of objects which can then be inspected, notably the
1.15 rm (RSVP machine) object which provides the following methods:
1.16 @@ -29,17 +30,23 @@
1.17
1.18 To run a test and check the output, specify the -t option:
1.19
1.20 - python test.py tests/logical.py -t
1.21 + python test.py tests/logical.py -t -omax
1.22
1.23 To run all tests, use the test_all.py program:
1.24
1.25 - python test_all.py
1.26 + python test_all.py -omax
1.27
1.28 Both programs support optimisations either using the -o flag immediately
1.29 followed (no space or separator) by a comma-separated list of options (defined
1.30 in the docs/optimisations.txt document) or by specifying -omax to apply all
1.31 possible optimisations.
1.32
1.33 +It is generally recommended to apply all possible optimisations when
1.34 +generating programs as this dramatically reduces the size of the program and
1.35 +accompanying structures, and it also makes the code generation process
1.36 +substantially faster. Optimisations should not cause programs to fail: they
1.37 +should all always be "safe" to apply.
1.38 +
1.39 Contact, Copyright and Licence Information
1.40 ------------------------------------------
1.41