File	Date	Author	Commit
bin	2012-12-12	Robin Verschoren	[bd7f26] Added .jar-archive in bin/.
exampleData	2012-12-12	Robin Verschoren	[11b2ba] Initial commit
exampleOutput	2012-12-12	Robin Verschoren	[11b2ba] Initial commit
schema	2012-12-12	Robin Verschoren	[11b2ba] Initial commit
src	2012-12-12	Robin Verschoren	[bd7f26] Added .jar-archive in bin/.
testFiles	2012-12-12	Robin Verschoren	[11b2ba] Initial commit
AUTHORS	2012-12-12	Robin Verschoren	[11b2ba] Initial commit
COPYING	2012-12-12	Robin Verschoren	[11b2ba] Initial commit
Doxyfile	2012-12-12	Robin Verschoren	[11b2ba] Initial commit
README.txt	2012-12-12	Robin Verschoren	[bd7f26] Added .jar-archive in bin/.
cli-manifest.txt	2012-12-12	Robin Verschoren	[bd7f26] Added .jar-archive in bin/.
presentation.pdf	2012-12-12	Robin Verschoren	[bd7f26] Added .jar-archive in bin/.

Read Me

************************************************
*GrAMP: Graph Algorithm illustration in Metapost*
************************************************

Installation instructions:
==========================
    Only prerequisites are a working Java Runtime Environment (JRE) version 6.

How to use:
===========
    In the main folder, use the following line in a terminal:
    
        java -jar bin/CLIGramp.jar <input.xml> <output.mp>

    This will compile the inputfile <input.xml> to a MetaPost-file called <output.mp>.


    A graphical editor is in the works.


Concerning correct input:
XML-files are used as input:
	If you can read XMLSchema, you can look at the used schema in the schema-subfolder.
	If you can not read the schema properly, you can always take a quick glance at the provided examplefiles in the exampleData-folder. These files  document a lot of input options in quite clear language.

	Currently 5 fundamental graph algorithms are supported:
		*BFS (src-attribute in XML required);
		*DFS (src-attribute in XML optional);
		*Ford-Fulkerson (denoted by FordFulk in the XML-file)
				(src- and snk-attributes in XML required)
				For every edge, a capacity has to be set with the attribute "cap";
		*Prim (src-attribute required);
		*Kruskal (src-attribute ignored).