X-Git-Url: http://svarog.pmf.uns.ac.rs/gitweb/?p=mjc2wsl.git;a=blobdiff_plain;f=README.md;h=352eb6728fa98a7133eaa76ba482ab05454597bf;hp=8014c1689cbdd559b9e20935dd43f96386f6996b;hb=90115096c6baec9ec70856a14b53ef9a90c4386a;hpb=5ec7c0162c03b3229de5dd9bb5264b8f76ff695e diff --git a/README.md b/README.md index 8014c16..352eb67 100644 --- a/README.md +++ b/README.md @@ -8,26 +8,38 @@ folder. More about the tools can be found in the "docs" folder. 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. +Running ant in the folder should compile the tool 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. Look in the "docs" folder for more details about running the available ant -tasks. +tasks, configurations, installations etc. Requirements ------------ -- java JDK for compiling and running the mjc2wsl tool and the MJ compiler + - 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 + - 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 + - FermaT for running the translated examples and applying the transformations + (FermaT Maintenance Environment can be used) + Downloads available at http://www.cse.dmu.ac.uk/~mward/fermat.html + +Check the docs folder for a more detailed tutorial on how to install +FermaT under Linux. + +This project should work correctly regardless of operating +system, that is it should work fine if you have the above +requirements setup properly (java-ant-fermat). + +It should be noted that although everything *should* work +on Windows or Mac or whatever else can run the dependencies, +it is only (at this point) extensively tested under Linux. +Feel free to ask about problems running it, suggestions for +improving the platform Independence are welcome. Setting the FermaT dir