Commit 253d222c authored by Kunshan Wang's avatar Kunshan Wang

New repo for the next refimpl.

parent 96dea960
......@@ -5,3 +5,4 @@ target
.settings
.idea
*.iml
*.swp
Simplest MicroVM Project
========================
MicroVM Reference Implementation 2
==================================
**This is an experimental project.** If you want to try out the MicroVM reference implementation, please visit the [microvm-refimpl](https://github.com/microvm-project/microvm-refimpl) project.
This project aims to be a much simpler (in term of conciseness) MicroVM implementation than the microvm-refimpl project. It is written in the Scala programming language.
**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)
[microvm-refimpl](https://github.com/microvm-project/microvm-refimpl) is the
previous reference implementation.
How to compile
--------------
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).
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).
To download all dependencies from the Maven central repository, invoke `sbt update`.
To download all dependencies from the Maven central repository, invoke `sbt
update`.
To generate the MicroVM IR parser from its Antlr grammar, invoke `sbt antlr4:antlr4Generate`.
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.
To compile, invoke `sbt compile` or do this in your favourite IDE.
To generate an Eclipse project, install the [sbt-eclipse plugin](https://github.com/typesafehub/sbteclipse) and invoke `sbt eclipse`.
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.
Author and Copyright
--------------------
......@@ -30,4 +45,8 @@ This project is released under the CC-BY-SA license. See `LICENSE`.
Contact
-------
Kunshan Wang <kunshan.wang@anu.edu.au>
\ No newline at end of file
Kunshan Wang <kunshan.wang@anu.edu.au>
<!--
vim: tw=80
-->
organization := "org.microvm"
name := "simplest-microvm-project"
name := "microvm-refimpl2"
description := "An attempt to make the simplest (in term of conciseness) Micro-VM implementation"
description := "The second reference implementation of MicroVM"
licenses := Seq("CC BY-SA 4.0" -> url("https://creativecommons.org/licenses/by-sa/4.0/legalcode"))
......@@ -22,4 +22,4 @@ antlr4GenListener in Antlr4 := false
antlr4GenVisitor in Antlr4 := false
EclipseKeys.createSrc := EclipseCreateSrc.Default + EclipseCreateSrc.Resource + EclipseCreateSrc.Managed
\ No newline at end of file
EclipseKeys.createSrc := EclipseCreateSrc.Default + EclipseCreateSrc.Resource + EclipseCreateSrc.Managed
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment