Permalink
Browse files

Update ReadMe.md

  • Loading branch information...
JonathanGiles committed Dec 23, 2018
1 parent aa1424b commit 2f5e26e51c9de0672b885f64472b3c36bffd5b6e
Showing with 22 additions and 20 deletions.
  1. +22 −20 ReadMe.md
@@ -2,26 +2,35 @@ Scenic View
===========

Scenic View is a JavaFX application designed to make it simple to understand the current state of your application scenegraph, and to also easily manipulate properties of the scenegraph without having to keep editing your code.
This lets you find bugs, and get things pixel perfect without having to do the compile-check-compile dance.
You can [learn more about Scenic View on its website](http://www.scenic-view.org).
This lets you find bugs, and get things pixel perfect without having to do the compile-check-compile dance.

[![Scenic View Screenshot](http://fxexperience.com/wp-content/uploads/2014/08/scenicView1.png)]()

## Build status

Builds for Windows, Linux, and MacOS are built by Azure Pipelines. The status of these builds is shown below:
Builds for JDK 11 for Windows, Linux, and MacOS are built by Azure Pipelines. The status of these builds is shown below:

| Platform | Status | Download |
|----------|--------|----------|
| Windows | [![Build Status](https://jonathangiles.visualstudio.com/Scenic%20View/_apis/build/status/Scenic%20View%20-%20JDK%2011%20-%20Windows)](https://jonathangiles.visualstudio.com/Scenic%20View/_build/latest?definitionId=5) | [Download](https://jogiles.blob.core.windows.net/scenic-view/scenicview-win.zip) |
| Platform | Status | Download for JDK 11 |
|----------|--------|---------------------|
| Windows | [![Build Status](https://jonathangiles.visualstudio.com/Scenic%20View/_apis/build/status/Scenic%20View%20-%20JDK%2011%20-%20Windows)](https://jonathangiles.visualstudio.com/Scenic%20View/_build/latest?definitionId=5) | [Download](https://jogiles.blob.core.windows.net/scenic-view/scenicview-win.zip)
| MacOS | [![Build Status](https://jonathangiles.visualstudio.com/Scenic%20View/_apis/build/status/Scenic%20View%20-%20JDK%2011%20-%20macOS)](https://jonathangiles.visualstudio.com/Scenic%20View/_build/latest?definitionId=7) | [Download](https://jogiles.blob.core.windows.net/scenic-view/scenicview-mac.zip) |
| Linux | [![Build Status](https://jonathangiles.visualstudio.com/Scenic%20View/_apis/build/status/Scenic%20View%20-%20JDK%2011%20-%20Linux)](https://jonathangiles.visualstudio.com/Scenic%20View/_build/latest?definitionId=6) | [Download](https://jogiles.blob.core.windows.net/scenic-view/scenicview-linux.zip) |

You can also download platform-independent releases [JDK 8](http://fxexperience.com/downloads/scenic-view-8-7-0/) and [JDK 9](http://fxexperience.com/downloads/scenic-view-9-0-0/).

## Java Version

Scenic View runs on Java 11 and JavaFX 11.
Scenic View has releases for JDK 8, JDK 9, and JDK 11:

- The JDK 8 release is in maintenance mode. No active development is ongoing, and the code exists in the jdk8 branch.
- The JDK 9 release is deprecated, and developers are encouraged to use either the JDK 8 release or the JDK 11 release.
- The JDK 11 release is the actively developed branch, and the code exists in the master branch.

For more information about JavaFX 11, see https://openjfx.io/openjfx-docs/.

## How to build
## Scenic View for JDK 11+

### How to build

Install a valid Java 11 version, and set `JAVA_HOME` accordingly.

@@ -39,9 +48,9 @@ You can also create a zipped version of that image for distribution:

./gradlew jlinkZip

## Use of Scenic View
### Using Scenic View

### Stand-alone application
#### Stand-alone application

Download the Scenic View custom image for your platform from the above links. Unzip and then run:

@@ -64,15 +73,15 @@ Alternatively, you can also run the `scenicview.jar` in any platform, providing
cd build/libs/
java --module-path /path-to/javafx-11-sdk/lib --add-modules javafx.web,javafx.fxml,javafx.swing -jar scenicview.jar

#### Notes
##### Notes

- Scenic View will detect JavaFX applications running on Java 9, 10 or 11.

- If the JavaFX application runs from a custom image (created via `link` or `jpackage`), it won't
have access to some required tools that are available when it runs from a regular JDK, and Scenic View won't be
able to find it.

### As a dependency
#### As a dependency

You can add `scenicview.jar` as a dependency to your JavaFX application. Since this jar doesn't include
the JavaFX dependencies, you should add them to your project, in case these weren't included yet.
@@ -113,13 +122,6 @@ Finally, you can run it from the application class:

ScenicView.show(scene);

## Java 8 version

There is a [jdk-8](https://github.com/JonathanGiles/scenic-view/tree/jdk-8) branch if you still
need Scenic View to run with Java 8.

You can also find the old distributions [here](http://fxexperience.com/scenic-view/).

## License

GNU General Public License v3.0-or-later
@@ -130,4 +132,4 @@ This project welcomes all types of contributions and suggestions.
We encourage you to report issues, create suggestions and submit pull requests.

Please go through the [list of issues](https://github.com/JonathanGiles/scenic-view/issues)
to make sure that you are not duplicating an issue.
to make sure that you are not duplicating an issue.

0 comments on commit 2f5e26e

Please sign in to comment.