Permalink
Browse files

Updated the README.

  • Loading branch information...
1 parent f0cca75 commit 335c731e43c1df5b87570c6b5453bee3c4f2377a @sjrd sjrd committed Mar 26, 2012
Showing with 37 additions and 17 deletions.
  1. +0 −17 README
  2. +37 −0 README.md
View
@@ -1,17 +0,0 @@
-This is a clean reimplementation of the Mozart virtual machine.
-
-
-Build instructions
-==================
-
-mozart$ mkdir build
-mozart$ cd build/
-build$ cmake ..
-build$ make
-
-
-Run the VM with its hardcoded program
-=====================================
-
-build$ cd vm/main/
-main$ ./vm
View
@@ -0,0 +1,37 @@
+# Mozart-Oz v2
+
+This is a clean reimplementation of the Mozart virtual machine.
+
+
+## Build instructions
+
+ mozart$ mkdir build
+ mozart$ cd build/
+ build$ cmake ..
+ build$ make
+
+This generates two "products":
+
+* `vm/main/libmozartvm.a`, which is the VM library
+* `vm/test/vmtest`, which is an executable that runs unit tests
+
+
+## Run the unit tests
+
+build$ vm/test/vmtest
+
+
+## Run an Oz program
+
+In the current stage of development, the VM cannot load programs, e.g., `.ozf`
+files. Only the VM library is available.
+
+If you want to experiment with actual Oz statements (which is likely), you
+should use the
+[bootstrap compiler](https://github.com/mozart/mozart2-bootcompiler).
+
+We also provide
+[a small testing environment](https://github.com/sjrd/mozart-app-test) in which
+you can easily write Oz code, compile it with the bootstrap compiler, and run
+it with the VM library. This is the recommended entry point for experimenting
+with Mozart2.

0 comments on commit 335c731

Please sign in to comment.