Skip to content

Commit

Permalink
Improve various README.md files.
Browse files Browse the repository at this point in the history
  • Loading branch information
fniephaus committed Sep 8, 2021
1 parent e9eef22 commit f2d5bbb
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 9 deletions.
4 changes: 3 additions & 1 deletion compiler/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# GraalVM Compiler

The GraalVM compiler is a dynamic compiler written in Java that integrates with the HotSpot JVM. It has a focus on high performance and extensibility.
In addition, it provides optimized performance for languages implemented with [Truffle Framework](https://github.com/graalvm/graal/tree/master/truffle)-based languages running on the JVM.
For brevity, the GraalVM compiler is often referred to as "the compiler" below.
Expand Down Expand Up @@ -165,7 +167,7 @@ Without leaving the `graal/vm` directory, you can now run libgraal as follows:

## Publications and Presentations

For video tutorials, presentations and publications on the GraalVM compiiler visit the [Publications](../docs/Publications.md) page.
For video tutorials, presentations and publications on the GraalVM compiler visit the [Publications](../docs/Publications.md) page.

## Building JVMCI JDK 8

Expand Down
2 changes: 1 addition & 1 deletion sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Graal Standard Development Kit
# GraalVM Standard Development Kit

The GraalVM SDK is a collection of APIs for the components of GraalVM.

Expand Down
8 changes: 5 additions & 3 deletions sulong/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Sulong

Sulong is a high-performance LLVM bitcode runtime built on the
[GraalVM](https://www.graalvm.org) by [Oracle Labs](https://labs.oracle.com).

Expand All @@ -8,15 +10,15 @@ With Sulong you can execute programming languages that can be transformed
to LLVM bitcode on GraalVM. This includes languages like C/C++, Fortran, and others.


# User Documentation
## User Documentation

Sulong is part of [GraalVM](https://www.graalvm.org). If you are a user of GraalVM and want
to run C/C++/... programs on GraalVM, we recommend downloading a pre-built binary of
[GraalVM](https://www.graalvm.org/downloads).

See [GraalVM LLVM Runtime](../docs/reference-manual/llvm/README.md) and [graalvm.org](https://www.graalvm.org/reference-manual/llvm/) for documentation about using the GraalVM LLVM runtime.

# Contributor Documentation
## Contributor Documentation

If you are interested in the internals of Sulong, or want to contribute, there are those
resources:
Expand All @@ -30,7 +32,7 @@ resources:
* [FAQ](docs/contributor/FAQ.md)


# Further Information
## Further Information

Sulong is developed in a research collaboration with
[Johannes Kepler University, Linz](http://www.ssw.jku.at).
2 changes: 1 addition & 1 deletion truffle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ forward in programming language implementation technology in the current era of
A growing body of shared implementation code and services
reduces language implementation effort significantly, but leads to competitive runtime
performance that matches or exceeds the competition. The value of the platform is further
increased by support for low-overhead language interoperation, as well as a general instrumentation
increased by support for low-overhead language interoperability, as well as a general instrumentation
framework that supports multi-language debugging and other external developer tools.

Truffle is developed and maintained by Oracle Labs and the Institute for System
Expand Down
2 changes: 1 addition & 1 deletion vm/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# VM suite
# VM Suite

The VM suite allows you to build custom GraalVM distributions, as well as installable components.
It defines a base GraalVM distribution that contains the JVMCI-enabled JDK, the GraalVM SDK, Truffle, and the GraalVM component installer.
Expand Down
4 changes: 2 additions & 2 deletions wasm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Feedback, bug reports, and open-source contributions are welcome!

## Building GraalWasm

### Prerequisits
### Prerequisites

- Python 3 (required by `mx`)
- git (to download, update, and locate repositories)
Expand Down Expand Up @@ -313,6 +313,6 @@ Value mainFunction = context.getBindings("wasm").getMember("example").getMember(
mainFunction.execute();
```

For more Polyglot-related examples, consult the documentation at the
For more polyglot-related examples, consult the documentation at the
[GraalVM website](https://www.graalvm.org/docs/reference-manual/polyglot/).

0 comments on commit f2d5bbb

Please sign in to comment.