Skip to content

Commit

Permalink
Update README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
rschatz committed Sep 5, 2018
1 parent 101c65b commit fd94f7e
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 18 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ implemented with the instrumentation framework.
compilation of Java applications under closed-world assumption into executable
images or shared objects.

* [Sulong](sulong/README.md) is an engine for running LLVM bitcode on GraalVM.

* [TRegex](regex/README.md) is an implementation of regular expressions which leverages GraalVM for efficient compilation of automata.

* [VM](vm/README.md) includes the components to build a modular GraalVM image.
Expand All @@ -36,7 +38,6 @@ GralVM allows running of following languages which are being developed and teste
* [FastR](https://github.com/oracle/fastr) - R Language 3.4.0
* [GraalPython](https://github.com/graalvm/graalpython) - Python 3.7
* [TruffleRuby](https://github.com/oracle/truffleruby/) - Ruby Programming Language 2.3.7
* [Sulong](https://github.com/graalvm/sulong) - LLVM bitcode interpreter
* [SimpleLanguage](https://github.com/graalvm/simplelanguage) - A simple demonstration language for the GraalVM.


Expand All @@ -49,4 +50,5 @@ the [GPL 2 with Classpath exception](truffle/LICENSE.GPL.md).
* [TRegex](/regex/) project is licensed under the [GPL 2 with Classpath exception](regex/LICENSE.GPL.md).
* The [Graal compiler](/compiler/) is licensed under the [GPL 2 with Classpath exception](compiler/LICENSE.md).
* [Substrate VM](/substratevm/) is licensed under the [GPL 2 with Classpath exception](substratevm/LICENSE.md).
* [Sulong](/sulong/) is licensed under [3-clause BSD](sulong/LICENSE).
* [VM](/vm/) is licensed under the [GPL 2 with Classpath exception](vm/GraalCE_license_3rd_party_license.txt).
23 changes: 8 additions & 15 deletions sulong/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@ as `clang`.
Graal VM
--------

Sulong is part of the [Graal VM](http://www.oracle.com/technetwork/oracle-labs/program-languages/overview/index.html).
Sulong is part of the [Graal VM](http://www.graalvm.org).
Graal VM supports Linux or Mac OS X on x86 64-bit systems.

1. Download the [Graal VM](http://www.oracle.com/technetwork/oracle-labs/program-languages/overview/index.html)
binaries.
1. Download the [Graal VM](http://www.graalvm.org/downloads/) binaries.
2. Extract the archive to your file system.
3. Add the Graal VM `/bin` folder to your `PATH` environment variable.

Expand Down Expand Up @@ -139,26 +138,26 @@ Then, download mx, which is the build tool used by Sulong:

Next, use git to clone the Sulong project and its dependencies:

git clone https://github.com/graalvm/sulong
git clone https://github.com/oracle/graal

Next, you need to download a recent
[labsjdk](http://www.oracle.com/technetwork/oracle-labs/program-languages/downloads/index.html).
Extract it inside the `sulong-dev` directory:

tar -zxf labsjdk-8u121-jvmci-0.29-linux-amd64.tar.gz
tar -zxf labsjdk-8u172-jvmci-0.47-linux-amd64.tar.gz

Set `JAVA_HOME` to point to the extracted labsjdk from above:

echo JAVA_HOME=`pwd`/labsjdk1.8.0_121-jvmci-0.29 > sulong/mx.sulong/env
echo JAVA_HOME=`pwd`/labsjdk1.8.0_172-jvmci-0.47 > graal/sulong/mx.sulong/env

Sulong partially consists of C/C++ code that is compiled using `make`. To speed
up the build process you can edit the `MAKEFLAGS` environment variable:

echo MAKEFLAGS=-j9 >> sulong/mx.sulong/env
echo MAKEFLAGS=-j9 >> graal/sulong/mx.sulong/env

Finally, build the project:

cd sulong && mx build
cd graal/sulong && mx build

The first build will take some time because `mx` has not only to build Sulong,
but also its dependencies and primary testsuite.
Expand Down Expand Up @@ -244,7 +243,7 @@ applied during compile-time, link-time, runtime, and offline.
What is Truffle?
----------------

[Truffle](https://github.com/graalvm/graal/tree/master/truffle) is a language
[Truffle](https://github.com/oracle/graal/tree/master/truffle) is a language
implementation framework written in Java. It allows language designers
to implement a (guest) language as an Abstract Syntax Tree (AST)
interpreter. Additionally, Truffle provides many language independent
Expand All @@ -253,12 +252,6 @@ language interoperability. When a Truffle AST is executed often and then
dynamically compiled with Graal, Graal can exploit its knowledge about the
Truffle framework and produce efficient machine code.

Build Status
------------

Thanks to Travis CI, all commits of this repository are tested:
[![Build Status](https://travis-ci.org/graalvm/sulong.svg?branch=master)](https://travis-ci.org/graalvm/sulong)

Further Information
-------------------

Expand Down
4 changes: 2 additions & 2 deletions truffle/docs/Languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This page is intended to keep track of the growing number of Truffle language im
* [Graal.js](http://www.oracle.com/technetwork/oracle-labs/program-languages/overview/index.html), an ECMAScript 2017 compliant JavaScript implementation. *
* [FastR](https://github.com/graalvm/fastr), an implementation of GNU R. *
* [TruffleRuby](https://github.com/graalvm/truffleruby), an implementation of Ruby. *
* [Sulong](https://github.com/graalvm/sulong), an LLVM bitcode interpreter. *
* [Sulong](https://github.com/oracle/graal/sulong), an LLVM bitcode interpreter. *
* [Graal.Python](http://www.oracle.com/technetwork/oracle-labs/program-languages/overview/index.html), an early-stage implementation of Python. *
* [TruffleSOM](https://github.com/SOM-st/TruffleSOM), a SOM Smalltalk implementation.
* [SOMns](https://github.com/smarr/SOMns), a Newspeak implementation for Concurrency Research.
Expand All @@ -31,4 +31,4 @@ This page is intended to keep track of the growing number of Truffle language im
* [shen-truffle](https://github.com/ragnard/shen-truffle), a port of the Shen programming language.
* [bf](https://github.com/chumer/bf/), an experimental Brainfuck programming language implementation.

Feel free to submit a [pull request](https://help.github.com/articles/using-pull-requests/) to add/remove from this list.
Feel free to submit a [pull request](https://help.github.com/articles/using-pull-requests/) to add/remove from this list.

0 comments on commit fd94f7e

Please sign in to comment.