# HG changeset patch # User Paul Boddie # Date 1215976564 -7200 # Node ID 629ce8edb09bfe11ce253daef4d6e54ba45030a8 # Parent b79902beb04fe9660c4c02507d0cff21f417c72f Added some documentation. diff -r b79902beb04f -r 629ce8edb09b README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.txt Sun Jul 13 21:16:04 2008 +0200 @@ -0,0 +1,43 @@ +Introduction +------------ + +The simplify package is an attempt to support type propagation on complete +Python programs. It is no longer under development. + +Quick Start +----------- + +Try running the test program. For example: + +python test.py tests/class.py -d -i -ms + +Some different options can be given to the test program: + +Option Effect +------ ------ + +-d Create a directory of XHTML documents in the current directory showing + the program source code along with type information and instance + summaries +-g Generate a dump of "RSVP" code (a kind of assembly language) +-i Fix instances identified by the program (for modes where multiple + instances are being used) +-m Support multiple kinds of instances for each class +-mp Support multiple kinds of instances for each class in "prolific" mode + (which means that a large number of kinds of instances are produced, + but with some restrictions) +-ms Support multiple kinds of instances for each class in "selective" mode + (which means that a large number of kinds of instances are produced, + but with a number of restrictions which limit that number fairly + effectively) +-s Support a single kind of instance for each class + +Contact, Copyright and Licence Information +------------------------------------------ + +The author can be contacted at the following e-mail address: + +paul@boddie.org.uk + +Copyright and licence information can be found in the docs directory - see +docs/COPYING.txt and docs/gpl-3.0.txt for more information.