1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Sun Jul 13 21:16:04 2008 +0200
1.3 @@ -0,0 +1,43 @@
1.4 +Introduction
1.5 +------------
1.6 +
1.7 +The simplify package is an attempt to support type propagation on complete
1.8 +Python programs. It is no longer under development.
1.9 +
1.10 +Quick Start
1.11 +-----------
1.12 +
1.13 +Try running the test program. For example:
1.14 +
1.15 +python test.py tests/class.py -d -i -ms
1.16 +
1.17 +Some different options can be given to the test program:
1.18 +
1.19 +Option Effect
1.20 +------ ------
1.21 +
1.22 +-d Create a directory of XHTML documents in the current directory showing
1.23 + the program source code along with type information and instance
1.24 + summaries
1.25 +-g Generate a dump of "RSVP" code (a kind of assembly language)
1.26 +-i Fix instances identified by the program (for modes where multiple
1.27 + instances are being used)
1.28 +-m Support multiple kinds of instances for each class
1.29 +-mp Support multiple kinds of instances for each class in "prolific" mode
1.30 + (which means that a large number of kinds of instances are produced,
1.31 + but with some restrictions)
1.32 +-ms Support multiple kinds of instances for each class in "selective" mode
1.33 + (which means that a large number of kinds of instances are produced,
1.34 + but with a number of restrictions which limit that number fairly
1.35 + effectively)
1.36 +-s Support a single kind of instance for each class
1.37 +
1.38 +Contact, Copyright and Licence Information
1.39 +------------------------------------------
1.40 +
1.41 +The author can be contacted at the following e-mail address:
1.42 +
1.43 +paul@boddie.org.uk
1.44 +
1.45 +Copyright and licence information can be found in the docs directory - see
1.46 +docs/COPYING.txt and docs/gpl-3.0.txt for more information.