****************************************************
**  README for running the testing code for TaML  **
**  testall.sh					  **
****************************************************

====================================================
==		Before Using			  ==
====================================================

Shell Path: The shell path is currently set to
"usr/bin/shell" on line 16 of testall.sh.  
Based on your system, this path may need to be 
changed in order to point to your shell executable

Windows Users: Due to the windows/unix differences,
running this code in a Windows/Cygwin environment
can cause an error complaining about carriage returns
('/r').  In this case, uncomment line 18 of testall.sh
to convert the file to the proper Unix style. This
command should typically only need to be run once				


====================================================
==	Running/Interpreting the Tests		  ==
====================================================

To run the tests, simply run the shell script from the
TaML main project folder: type "./testall.sh"

The command line will display a brief note, 
"See test_results.out for detailed results" while the 
test is running. 

If any differences are found between the generated results
and the expected results, the command line will give you a 
brief summary of the differnces.

A detailed descriptions of the differences can be found
in "test_results.out"

After the tests are done running, a summary will be displayed
(in both the command line and in test_results.out) showing
how many tests have failed. 

For example, if the tests were successful and nothing failed,
you will see a message such as, 
"There were 0 out of 24 test cases which failed"


=======================================================
==		Folder Setup			     ==
=======================================================

File extensions in test-input and test-output folders:

.taml -- "master" input file (only found in test-intput folder)
.scanner -- testing output after the Scanner phase.  Prints
	out tokens in a string-friendly format
.parser -- testing output after the Parser phase. Outputs the 
	AST structure.
.sast -- testing output after semantic checking. Outputs a 
	semantically correct AST
.java -- taml code which has been translated into java
.out -- the final output resulting from running a .taml file


Folder: test-input -- contains all input files.  This folder
thus only contains .taml files

folder: test-output -- contains all output files with
the expected, "golden" results.  This folder thus contains
.scanner, .parser, .sast, .java, and .out files. 
