From: Doni Pracner <quinnuendo@gmail.com>
Date: Mon, 16 Dec 2013 19:02:30 +0000 (+0100)
Subject: added a README file
X-Git-Tag: v0.1.3~1
X-Git-Url: http://svarog.pmf.uns.ac.rs/gitweb/?p=mjc2wsl.git;a=commitdiff_plain;h=121f40c4c8c852caefaf25001552f208435a966c

added a README file
---

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..4d942d7
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,45 @@
+MJC2WSL - convert MicroJava Compiled Bytecode to WSL/FermaT
+===========================================================
+
+Quick build and test
+--------------------
+
+Running ant in the folder should compile the tool as well
+as the MJ compiler and then do a test - compile all of the
+sample MicroJava codes into MJ bytecode, translate them
+to WSL and then apply the given transformations in MetaWSL
+to the programs.
+
+
+Requirements
+------------
+
+- java JDK for compiling and running the mjc2wsl tool and the MJ compiler
+
+- ant for building and testing
+-- ant-contrib tasks are needed for some of the tasks
+
+- FermaT for running the translated examples and applying the transformations
+(FermaT Maintanance Environment can be used)
+Downloads available at http://www.cse.dmu.ac.uk/~mward/fermat.html
+
+
+Setting the FermaT dir
+----------------------
+
+The ant build script assumes that Fermat is in "C:/fermat3" under
+Windows and "~/fermat3" for everything else (Linux/Mac...).
+
+If you need to change this you can rename (or copy) the given
+file "custom.properties.default" to "custom.properties" and
+specify a correct path for your system.
+
+
+Contact
+-------
+
+Project home:
+http://perun.dmi.rs/pracner/transformations
+
+Feel free to contact Doni Pracner if you have any problems, ideas 
+or suggestions.
\ No newline at end of file