README.txt for the IDGGen tool

About the tool
--------------

The tool creates an Inter-Dependency Graph from a Play-Engine specification. The resulting file is the input for the SIV tool.
If you have a Play-Engine specification that you would like to view in SIV, you must first use this tool to create the appropriate input for SIV.


Usage
-----
Execute IDGGen.exe.
In the first text box, insert the full path to the Play-Engine workspace file (or use the browse button).

Now select where the application data should be read from:

* If your specification has a GUI, you must choose one of the first options (either "from GUI", or "XML filename"). 
  - The simplest option is "from GUI". Try this first. 
  - If "from GUI" does not work, then there's probably DLL versioning conflicts, and you better use the second option. For that you'll need to know the xml file that the GUI uses. For the Play-Engine samples, this is app<sampleName>.xml. If you're using your own GUI, then that could be different. Try looking for an xml file in the project directory that is not mentioned in the ews file.

* If your specification has no GUI, then you can select either "none" or "from GUI".

Now click "Go!". The tool will hang for a few seconds (or longer if your specification is large). Be patient!

Eventually, the IDG wizard dialog box should show. Select the LSCs that you want to appear in the IDG (or use one of the three "select XXX" buttons), insert a target filename (or use the browse button), and click OK.

The IDGGen tool should now notify you of its success. Congratulations, your IDG file is ready! You can now start SIV and view the graph...


For any questions, you can contact me at itai.segall@weizmann.ac.il