README.md

   1 MJC2WSL - convert MicroJava Compiled Bytecode to WSL/FermaT
   2 ===========================================================
   3
   4 mjc2wsl is distributed under the GPL licence, for more details check the src
   5 folder. More about the tools can be found in the "docs" folder.
   6
   7
   8 Quick build and test
   9 --------------------
  10
  11 Running ant in the folder should compile the tool and then do a test -
  12 compile all of the sample MicroJava codes into MJ bytecode, translate them
  13 to WSL and then apply the given transformations in MetaWSL to the programs.
  14
  15 Look in the "docs" folder for more details about running the available ant
  16 tasks, configurations, installations etc.
  17
  18
  19 Requirements
  20 ------------
  21
  22  - java JDK for compiling and running the mjc2wsl tool and the MJ compiler
  23
  24  - ant for building and testing
  25       - ant-contrib tasks are needed for some of the tasks
  26
  27  - FermaT for running the translated examples and applying the transformations
  28    (FermaT Maintenance Environment can be used)
  29    Downloads available at http://www.cse.dmu.ac.uk/~mward/fermat.html
  30
  31 Check the docs folder for a more detailed tutorial on how to install
  32 FermaT under Linux.
  33
  34 This project should work correctly regardless of operating
  35 system, that is it should work fine if you have the above
  36 requirements setup properly (java-ant-fermat).
  37
  38 It should be noted that although everything *should* work
  39 on Windows or Mac or whatever else can run the dependencies,
  40 it is only (at this point) extensively tested under Linux.
  41 Feel free to ask about problems running it, suggestions for
  42 improving the platform Independence are welcome.
  43
  44
  45 Setting the FermaT dir
  46 ----------------------
  47
  48 The ant build script assumes that Fermat is in "C:/fermat3" under Windows
  49 and "~/fermat3" for everything else (Linux/Mac...).
  50
  51 If you need to change this you can rename (or copy) the given file
  52 "custom.properties.default" to "custom.properties" and specify a correct
  53 path for your system.
  54
  55
  56 About MicroJava
  57 ---------------
  58
  59 This is a simple language made by H. Mössenböck for a Compiler Construction
  60 course.  It is NOT the same as Java Micro Edition (JavaME) used on mobile
  61 phones.
  62
  63 For details about the language and the version used in this project check
  64 out the "docs" folder.
  65
  66 More about the course, the language and its VM:
  67 http://www.ssw.uni-linz.ac.at/Misc/CC/
  68
  69 A functional compiler is distributed in the lib folder for ease of testing
  70 and evaluating.  Check the folder for further details.
  71
  72
  73 Git status and mirrors
  74 ----------------------
  75
  76 The `master` branch should hold a stable version at all times.  The `work`
  77 branch is usually the current status of the tool, probably stable as well,
  78 but more experimental and untested. There is a possibility of other feature
  79 branches appearing here and there. These are not neccessarily on all mirrors
  80 at the same time. Efforts are made that master is always in sync.
  81
  82 mjc2wsl has a primary git repo on svarog.pmf.uns.ac.rs:
  83
  84     http://svarog.pmf.uns.ac.rs/gitweb/?p=mjc2wsl.git
  85
  86 mirrors are also available:
  87
  88     https://bitbucket.org/quinnuendo/mjc2wsl
  89
  90     https://github.com/quinnuendo/mjc2wsl
  91
  92
  93 Contact
  94 -------
  95
  96 Project home:
  97 http://perun.dmi.rs/pracner/transformations
  98
  99 Feel free to contact Doni Pracner if you have any problems, ideas
 100 or suggestions.