version string 1.0.0

[mjc2wsl.git] / README.md
diff --git a/README.md b/README.md

index 8014c16..920875e 100644 (file)
--- 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
  --------------------
  
  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
  
  Look in the "docs" folder for more details about running the available ant
-tasks.
+tasks, configurations, installations etc.
  
  
  Requirements
  ------------
  
  
  
  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
  
  
  Setting the FermaT dir
@@ -58,6 +70,26 @@ A functional compiler is distributed in the lib folder for ease of testing
  and evaluating.  Check the folder for further details.
  
  
  and evaluating.  Check the folder for further details.
  
  
+Git status and mirrors
+----------------------
+
+The `master` branch should hold a stable version at all times.  The `work`
+branch is usually the current status of the tool, probably stable as well,
+but more experimental and untested. There is a possibility of other feature
+branches appearing here and there. These are not neccessarily on all mirrors
+at the same time. Efforts are made that master is always in sync.
+
+mjc2wsl has a primary git repo on svarog.pmf.uns.ac.rs:
+
+ - http://svarog.pmf.uns.ac.rs/gitweb/?p=mjc2wsl.git
+
+mirrors are also available:
+
+ - https://bitbucket.org/quinnuendo/mjc2wsl
+
+ - https://github.com/quinnuendo/mjc2wsl
+
+
  Contact
  -------
  
  Contact
  -------