Skip to content

Commit

Permalink
chore(Monocle): Update README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
hastebrot committed Nov 12, 2014
1 parent 2a2862b commit 3ff9b62
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
Monocle is the implementation of the Glass windowing component of JavaFX for embedded systems. It
is part of the Java Platform since version 8u20, but not included in builds for desktop platforms
(Windows, Linux, Mac).

This repository provides pre-packaged builds of Monocle taken from the OpenJFX project. The builds
include components to run in headless environments. They do not include native libraries for
low-level access.

## Build (under Windows)

Clone the repository and checkout the branch.

```
C:\> git clone https://github.com/TestFX/Monocle
C:\> cd Monocle
C:\> git checkout runtime-8u20
```

Choose the JDK version and build the jars.

```
C:\> set JAVA_HOME=C:\Program Files\Java\jdk1.8.0_20
C:\> gradlew clean jar
C:\> dir build\libs
```

## Update Instructions

To update the build to newer versions of Monocle just copy source code files from
[src/main/java/com/sun/glass/ui/monocle] into the directory `src\main\java` and resource files
from [src/main/resources/com/sun/glass/ui/monocle] into the directory `src\main\resources`. Use
the links `bz2`, `zip` or `gz` to export the files as archive.

You can update to a certain version by changing `tip` in the URLs to a changeset hash. There is a
list of changeset hashes at [http://hg.openjdk.java.net/openjfx/8u-dev/rt/tags]().

Example changeset hashes:

- **8u20-b26:** `e56a8bbcba20` instead of `tip`.
- **8u25-b18:** `b2021af209c3` instead of `tip`.
- **8u40-b13:** `b90398073b6a` instead of `tip`.

[src/main/java/com/sun/glass/ui/monocle]: http://hg.openjdk.java.net/openjfx/8u-dev/rt/file/tip/modules/graphics/src/main/java/com/sun/glass/ui/monocle
[src/main/resources/com/sun/glass/ui/monocle]: http://hg.openjdk.java.net/openjfx/8u-dev/rt/file/tip/modules/graphics/src/main/resources/com/sun/glass/ui/monocle

0 comments on commit 3ff9b62

Please sign in to comment.