[Mumps2Py:] [142] revised and updated.

[subversion@xxxxxxxxxxxxx]

Revision: 142
Author:   pgallot
Date:     2008-02-29 05:36:50 +0000 (Fri, 29 Feb 2008)

Log Message:
-----------
revised and updated.

Modified Paths:
--------------
    trunk/README.txt


Modified: trunk/README.txt
===================================================================
--- trunk/README.txt	2008-02-28 22:36:33 UTC (rev 141)
+++ trunk/README.txt	2008-02-29 05:36:50 UTC (rev 142)
@@ -10,7 +10,7 @@
 
 From the menu, select File->Open
 
-select a Mumps file to open (e.g. simpleconditionals.mps)
+select a Mumps file to open (e.g. pattern_matching.mps)
 
 	The file should then be displayed in the left-side pane.
 From the menu, select Parse->Parse All
@@ -18,4 +18,32 @@
 	and the right-side pane will show what Mumps2Py was able to translate.
 
 To save the translation from the right-side pane, from the menu, select File->Save
+
+If you have a Mumps file containing multiple routines (that mumps2py is able to extract routines from),
+you can create an m2p file for it via the File->Create m2p File menu.  Creating an m2p file also 
+creates an idx file of the same name, which removes the need to parse for routines every time the
+input file is selected.  An m2p also allows you to exclude certain routines from being processed. 
+
+From the Parse menu:
+- the List routines menu item will show which routines are contained within the current
+input file.
+- the Scan For Errors menu item will attempt to parse each of the routines, and will display
+a report indicating which routines, if any, triggered parse errors.
+- the Analyze Tokens menu item will display a sorted frequency count of all the different token types
+used by the file or the currently selected routine.
+- the Parse From... menu item is debugging cruft that can probably be removed now.
+- the Parse until routine... menu item is also debugging cruft, but slightly useful for
+internal historical comparisons.
+- the Parse Routine... menu item allows you to specify the name of a routine to parse and translate.
+
+From the Run menu:
+- routine decomposition shows a string representation of the raw tokens extracted from the parser
+- label report shows a string representation of the raw label tokens extracted from the parser.
+- entryref report shows the same but for the entryref tokens.
+- The referrals report looks for at all the other routines in the file to see if one of their entryrefs
+directly calls the current routine.
+- Save and run will save the translation of the current routine and attempt to execute it.
+- The Regression Test Run menu item executes all of the translation regression tests that have been set up.
+- Add regression Test will translate and execute the currently open file, saving the output for comparisons with
+future regression test runs.