README.md 1.69 KB
Newer Older
1 2
MicroVM Reference Implementation 2
==================================
Kunshan Wang's avatar
Kunshan Wang committed
3

4 5 6 7 8
**WORKING IN PROGRESS.** This project will be the next reference implementation
of MicroVM. It is based on the
[simplest-microvm-project](https://github.com/microvm/simplest-microvm-project).
This project will implement the currently MicroVM spec in
[microvm-spec](https://github.com/microvm/microvm-spec/wiki)
Kunshan Wang's avatar
Kunshan Wang committed
9

10 11
[microvm-refimpl](https://github.com/microvm-project/microvm-refimpl) is the
previous reference implementation.
Kunshan Wang's avatar
Kunshan Wang committed
12 13 14 15

How to compile
--------------

16 17 18 19
You need [Scala](http://scala-lang.org/) 2.11 and
[sbt](http://www.scala-sbt.org/) 0.13. It is recommended to install them using
the package manager of your operating system or distribution (including apt-get,
yum, pacman, etc. for GNU/Linux distributions and Homebrew for Mac OS X).
Kunshan Wang's avatar
Kunshan Wang committed
20

21 22
To download all dependencies from the Maven central repository, invoke `sbt
update`.
Kunshan Wang's avatar
Kunshan Wang committed
23

24 25 26 27
To generate the MicroVM IR parser from its Antlr grammar, invoke `sbt
antlr4:antlr4Generate`. The generated sources will be in
`target/scala-2.11/src_managed`. Make sure your IDE can see those generated
sources.
Kunshan Wang's avatar
Kunshan Wang committed
28 29 30

To compile, invoke `sbt compile` or do this in your favourite IDE.

31 32 33 34 35
To generate an Eclipse project, install the [sbt-eclipse
plugin](https://github.com/typesafehub/sbteclipse) and invoke `sbt eclipse`.

IntelliJ IDEA has plugins for Scala and SBT. Make sure you don't commit `.idea`
or generated project files into the repository.
Kunshan Wang's avatar
Kunshan Wang committed
36 37 38 39 40 41 42 43 44 45 46 47

Author and Copyright
--------------------

This project is created by Kunshan Wang, Yi Lin, Steve Blackburn, Antony
Hosking, Michael Norrish.

This project is released under the CC-BY-SA license. See `LICENSE`.

Contact
-------

48 49 50 51 52
Kunshan Wang <kunshan.wang@anu.edu.au>

<!--
vim: tw=80
-->