COMP 763 - 001				110236739
Hans Vangheluwe				Reehan Shaikh
Winter 2008				May 2

		Project README

STRUCTURE:
----------
In this "project" folder, there are two subfolders,
"docs" which holds the project documents and
"muModelica" which holds the compiler implementation.

Under "docs", there are two files for the class
presentation (the original OpenOffice file and the
PDF version). There is also a "report" folder which
contains the LaTeX source for the report. A makefile
is included for those who want to recompile the
document. The main .tex file is source.tex which uses
the content in the "content" folder to prepare the
document, as well as the lncs package files. Please
use exactly this directory structure otherwise the
LaTeX compiler won't find the files to include.

Under the "muModelica" folder, the following files
were added/modified:

+ examples/digitalWatchStatechart/*
- holds the partial DigitalWatch example used in the
  report and the complete one used as a proof of
  validity for the compiler

+ lib/statecharts.*
- holds the library classes for implementing  Modelica
  statecharts

+ mmc.py
- the actual compiler file that glues together all the
  compiler's components, parses the command line options,
  gets called by the user

+ statecharts/*
- the statechart printer to print the proper DES code

USAGE:
------
1) See readme.txt for initial environment variable
   settings and installing dependent packages (pyGK)
2) Go to the directory with your statechart model,
   say model.mo. For now, you must be in the same
   directory where your model specification is!
3) Issue the following command:
	python path/to/mmc.py -z model.mo
4) In the same directory, you will have files with the
   same name but .agl extension (this is the xml version
   of the AST) and another with the .des extension (this
   is the compiled code to give to SCC).

Email reehan.shaikh@cs.mcgill.ca if you have any problems.
