Skip to content

Commit

Permalink
Prepare 0.1.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
msgilligan committed Feb 7, 2021
1 parent a8337bd commit d18e03a
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 15 deletions.
10 changes: 8 additions & 2 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

A high-level view of the changes in each SupernautFX release.

== v0.1.1-SNAPSHOT
== v0.1.1

Released: Under development
Released: 2020.02.07

=== New Features

Expand All @@ -16,6 +16,12 @@ Released: Under development

* Add `Launcher.launch` overload that doesn't require a BackgroundApp `Class`.

=== Documentation

* README.adoc updated
* Sample Gradle application in standalone project/repository.
* Sample Maven application in standalone project/repository.

=== Dependency Upgrades

* JavaFX 15.0.1
Expand Down
58 changes: 48 additions & 10 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
= Supernaut.FX
Sean Gilligan <https://github.com/msgilligan>
v0.1.0
v0.1.1
:description: Supernaut.FX DI Framework README.
:supernautfx-version: 0.1.0
:supernautfx-version: 0.1.1
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
Expand Down Expand Up @@ -66,23 +66,61 @@ You may also develop library modules for services depending only on `app.superna
* Your main "application" class need not extend `javafx.application.Application`
* `BrowserService` abstraction for opening links in Web Browser (abstraction of JavaFX `HostServices`)
* Ability to customize Micronaut `BeanContext` or `ApplicationContext`
* Micronaut-powered application configuration via `.yml`, `.json`, or `.properties` files (forthcoming, see https://github.com/SupernautApp/SupernautFX/issues/2)

== Getting Started

There is no user guide or "Getting Started" document, yet. Fortunately the framework is very simple -- currently only a handful of relatively simple classes. To get started do the following:
There is no user guide or "Getting Started" document, yet. Fortunately the framework is very simple -- currently only a handful of relatively simple classes. To get started, use either the sample Gradle or Maven project.

. Clone the project
=== Gradle Sample Project

The https://github.com/SupernautApp/supernaut-fx-sample-gradle[Gradle sample project] currently supports running your application via Gradle and building a jlink'ed and jpackage'd application via the https://github.com/beryx/badass-jlink-plugin[Badass Gradle JLink Plugin].

To build the jpackage'd app:

. `git clone [email protected]:SupernautApp/supernaut-fx-sample-gradle.git`
. `cd supernaut-fx-sample-gradle`
. `./gradlew jpackage`
. Open the `build/jpackage` directory and launch the native application for your platform.

Or to run the app directly from Gradle:

. `./gradlew run`

=== Maven Sample Project

The https://github.com/SupernautApp/supernaut-fx-sample-maven[Maven sample project] currently supports running your application via Maven and building a natively-compiled application via https://www.graalvm.org[GraalVM] and https://github.com/gluonhq/client-maven-plugin[Gluon Client Maven Plugin].

To build a GraalVM native-image:

. `git clone [email protected]:SupernautApp/supernaut-fx-sample-maven.git`
. `cd supernaut-fx-sample-maven`
. `mvn client:build`
. `mvn client:run` or open the `target/client` directory and launch the native application for your platform

Or to run the app directly from Maven:

. `mvn javafx:run`

== Building Supernaut

. Clone the repository
. Make sure your `JAVA_HOME` points to a JDK 11 or newer (but not greater than 15, Gradle doesn't support that yet)
. Configure a `JDK16` environment to point to a JDK 16 (currently in early access) installation
. `./gradlew buildCI buildJPackages`

The official builds are using JDK16 (early access) for the Java Toolchain, but if you want to build with JDK15, you can use:

. `./gradlew -PjavaToolchainVersion=15 buildCI buildJPackages`


To test one of the included sample apps:

. Run the sample Hello app
.. `./gradlew supernautfx-sample-hello:run`
.. `./gradlew supernaut-fx-sample-hello:run`
. Build a `jpackage`-ed Hello app
.. `./gradlew supernautfx-sample-hello:jpackage`
.. `./gradlew supernaut-fx-sample-hello:jpackage`
.. Open the `supernautfx-sample-hello/build/jpackage` directory and launch the native application for your platform
. Review the https://github.com/SupernautApp/SupernautFX/tree/master/supernaut-fx-sample-hello/src/main/java/app/supernaut/fx/sample/hello[source code for the Hello app]
. Review the https://github.com/SupernautApp/SupernautFX/tree/master/supernaut-fx/src/main/java/app/supernaut/fx[source code for Supernaut.FX]
. Start your own app!


== Inspired By

Expand Down
6 changes: 3 additions & 3 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
supernautVersion = 0.1.1-SNAPSHOT
helloAppVersion = 1.0.1
testAppVersion = 1.0.1
supernautVersion = 0.1.1
helloAppVersion = 1.0.2
testAppVersion = 1.0.2
signJPackageImages = false

# Major (whole number) version of JDK to use for javac, jlink, jpackage, etc.
Expand Down

0 comments on commit d18e03a

Please sign in to comment.