# HG changeset patch
# User Paul Boddie <paul@boddie.org.uk>
# Date 1259455869 -3600
# Node ID 2d4f70fd52dd62e718a5626c15106d6cb1057cbc
# Parent  089a32b3936cfb816bbbabb1ec3f93c715588cca
Added optimisations note.

diff -r 089a32b3936c -r 2d4f70fd52dd README.txt
--- a/README.txt	Sun Nov 29 01:46:46 2009 +0100
+++ b/README.txt	Sun Nov 29 01:51:09 2009 +0100
@@ -15,9 +15,10 @@
 -----------
 
 Currently, the test.py program is the principal means of compiling and running
-code. For example, to inspect the logical.py test program...
+code. For example, to inspect the logical.py test program (with all
+optimisations enabled)...
 
-  python -i test.py tests/logical.py -m
+  python -i test.py tests/logical.py -m -omax
 
 ...will provide a number of objects which can then be inspected, notably the
 rm (RSVP machine) object which provides the following methods:
@@ -29,17 +30,23 @@
 
 To run a test and check the output, specify the -t option:
 
-  python test.py tests/logical.py -t
+  python test.py tests/logical.py -t -omax
 
 To run all tests, use the test_all.py program:
 
-  python test_all.py
+  python test_all.py -omax
 
 Both programs support optimisations either using the -o flag immediately
 followed (no space or separator) by a comma-separated list of options (defined
 in the docs/optimisations.txt document) or by specifying -omax to apply all
 possible optimisations.
 
+It is generally recommended to apply all possible optimisations when
+generating programs as this dramatically reduces the size of the program and
+accompanying structures, and it also makes the code generation process
+substantially faster. Optimisations should not cause programs to fail: they
+should all always be "safe" to apply.
+
 Contact, Copyright and Licence Information
 ------------------------------------------