From 4fd0f252b7f9555e665c1101747ae30bb7f60154 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Pereda?= Date: Wed, 30 Oct 2024 23:57:55 +0100 Subject: [PATCH 01/11] Update README.md --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1b4bc433e..a27c068fc 100644 --- a/README.md +++ b/README.md @@ -80,12 +80,11 @@ com.oracle.javafx.scenebuilder.app.SceneBuilderApp ## Scene Builder Kit ## -To build and install the Scene Builder Kit in your local repository, run: +[![Build](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml/badge.svg)](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml) +[![Maven Central](https://img.shields.io/maven-central/v/com.gluonhq.scenebuilder/kit)](https://search.maven.org/#search|ga|1|com.gluonhq.scenebuilder) +[![License](https://img.shields.io/github/license/gluonhq/scenebuilder)](https://opensource.org/licenses/GPL-3.0) -`mvn clean install -f kit` - -The custom controls of the Scene Builder kit can be used in your project. -You can add it as a regular dependency to the build of your app: +Scene Builder Kit is published to Maven Central, and you can add it as a regular dependency to the build of your app: ``` @@ -95,6 +94,14 @@ You can add it as a regular dependency to the build of your app: ``` +You can use Scene Builder Kit embedded in your project. A simple demo can be found here: https://github.com/gluonhq/EmbeddedSceneBuilderDemo + +Also you can use in your projects the controls available in Scene Builder Kit. + +If you want to build and install the Scene Builder Kit in your local repository, run: + +`mvn clean install -f kit` + ## Code Style To ensure that new code formatting matches the requirements for Pull Requests, From ab77b1820846e7c5b84e690926022c5d2d2e3224 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Pereda?= Date: Thu, 31 Oct 2024 00:07:55 +0100 Subject: [PATCH 02/11] add javadoc badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a27c068fc..1639cfd9b 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,7 @@ com.oracle.javafx.scenebuilder.app.SceneBuilderApp [![Build](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml/badge.svg)](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml) [![Maven Central](https://img.shields.io/maven-central/v/com.gluonhq.scenebuilder/kit)](https://search.maven.org/#search|ga|1|com.gluonhq.scenebuilder) [![License](https://img.shields.io/github/license/gluonhq/scenebuilder)](https://opensource.org/licenses/GPL-3.0) +[![javadoc](https://javadoc.io/badge2/com.gluonhq.scenebuilder/kit/javadoc.svg?color=blue)](https://javadoc.io/doc/com.gluonhq.scenebuilder/kit) Scene Builder Kit is published to Maven Central, and you can add it as a regular dependency to the build of your app: From f5dbb38cd0c7cda5c3fab36564c7b29c76b01491 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Pereda?= Date: Thu, 31 Oct 2024 17:49:12 +0100 Subject: [PATCH 03/11] Update README.md --- README.md | 42 +++++++++++++++++++++++++++++++----------- 1 file changed, 31 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1639cfd9b..8ecdb6783 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ +[![Gluon](.github/assets/gluon_logo.svg)](https://gluonhq.com) + # Gluon Scene Builder # +[![Build](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml/badge.svg)](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml) +[![License](https://img.shields.io/github/license/gluonhq/scenebuilder)](https://opensource.org/licenses/GPL-3.0) + +Scene Builder Kit: +[![Maven Central](https://img.shields.io/maven-central/v/com.gluonhq.scenebuilder/kit)](https://search.maven.org/#search|ga|1|com.gluonhq.scenebuilder) +[![javadoc](https://javadoc.io/badge2/com.gluonhq.scenebuilder/kit/javadoc.svg?color=blue)](https://javadoc.io/doc/com.gluonhq.scenebuilder/kit) + Gluon [Scene Builder](http://gluonhq.com/products/scene-builder/) is a drag and drop UI designer tool allowing rapid desktop and mobile app development. Scene Builder separates design from logic, allowing team members to quickly and easily focus on their specific aspect of application development. @@ -44,7 +53,7 @@ These are the requisites: ### How to build Scene Builder ### -Scene Builder makes use of the Maven Wrapper to build and run the project. So there is no need to install Maven on the developers machine. To utilize Maven Wrapper, instead of calling `mvn`, one can run `./mvnw` on Linux or macOS or `mvnw` on Windows instead. +Scene Builder makes use of the Maven Wrapper to build and run the project. So there is no need to install Maven on the developers machine. To utilize Maven Wrapper, instead of calling `mvn`, one can run `./mvnw` on Linux or macOS or `mvnw` on Windows. To build the Scene Builder services, on the project's root, run: @@ -78,12 +87,27 @@ java \ com.oracle.javafx.scenebuilder.app.SceneBuilderApp ``` -## Scene Builder Kit ## +## Scene Builder components ## -[![Build](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml/badge.svg)](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml) -[![Maven Central](https://img.shields.io/maven-central/v/com.gluonhq.scenebuilder/kit)](https://search.maven.org/#search|ga|1|com.gluonhq.scenebuilder) -[![License](https://img.shields.io/github/license/gluonhq/scenebuilder)](https://opensource.org/licenses/GPL-3.0) -[![javadoc](https://javadoc.io/badge2/com.gluonhq.scenebuilder/kit/javadoc.svg?color=blue)](https://javadoc.io/doc/com.gluonhq.scenebuilder/kit) +The Scene Builder project has three main components defined by three modules (that is, three Java modules defined in three Maven modules subprojects): + +- Scene Builder App +- Scene Builder Kit +- Gluon plugin + +### Scene Builder App ### + +Contains the JavaFX main application that embeds the Scene Builder Kit, and includes menus, preferences and dialogs to interact with it. + +### Scene Builder Kit ### + +Scene Builder Kit is the core of the project, defines three main areas: + +- Left: Library of custom and built-in controls, Hierarchy and Controller of the FXML layout being edited +- Center: Workspace area for displaying the content of the FXML layout that is being designed +- Right: Inspector with properties, layout and event handlers of the components of the FXML layout. + +Kit is an API that allows the integration of these components and their functionallity with other applications or IDEs, being Scene Builder App the best example of such integration. Other basic example can be found here: [EmbeddedSceneBuilderDemo](https://github.com/gluonhq/EmbeddedSceneBuilderDemo). Also you can use in your projects the controls available in Scene Builder Kit. Scene Builder Kit is published to Maven Central, and you can add it as a regular dependency to the build of your app: @@ -95,10 +119,6 @@ Scene Builder Kit is published to Maven Central, and you can add it as a regular ``` -You can use Scene Builder Kit embedded in your project. A simple demo can be found here: https://github.com/gluonhq/EmbeddedSceneBuilderDemo - -Also you can use in your projects the controls available in Scene Builder Kit. - If you want to build and install the Scene Builder Kit in your local repository, run: `mvn clean install -f kit` @@ -117,7 +137,7 @@ To run the plugin: mvn checkstyle:checkstyle ``` -There will be a report for each sub-project, one for `app` and one for `kit`. +There will be a report for each sub-project: * Kit: `kit/target/reports/checkstyle.html` * App: `app/target/reports/checkstyle.html` From 79780a6f84c0cc29fb68c4d0ff2acba9b8fd9e77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Pereda?= Date: Thu, 31 Oct 2024 17:55:26 +0100 Subject: [PATCH 04/11] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 8ecdb6783..cfbd472a4 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,12 @@ If you want to build and install the Scene Builder Kit in your local repository, `mvn clean install -f kit` +### Gluon plugin ### + +The Gluon section in the Library allows adding [Gluon Mobile](http://gluonhq.com/products/mobile) controls to the FXML layout, and setting the stylesheets from the Gluon themes and swatch colors. + +An easy way to get started is by selecting the Mobile Basic Screen from the available templates in the welcome dialog. + ## Code Style To ensure that new code formatting matches the requirements for Pull Requests, From 6022e91f2fb409274fecc8e5a028c72928202178 Mon Sep 17 00:00:00 2001 From: "jose.pereda" Date: Thu, 31 Oct 2024 17:57:52 +0100 Subject: [PATCH 05/11] add logo --- .github/assets/gluon_logo.svg | 195 ++++++++++++++++++++++++++++++++++ 1 file changed, 195 insertions(+) create mode 100644 .github/assets/gluon_logo.svg diff --git a/.github/assets/gluon_logo.svg b/.github/assets/gluon_logo.svg new file mode 100644 index 000000000..06aff6243 --- /dev/null +++ b/.github/assets/gluon_logo.svg @@ -0,0 +1,195 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From ce3334b3de0ac669302568a047a36aaa91aeb25f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Pereda?= Date: Thu, 31 Oct 2024 18:15:38 +0100 Subject: [PATCH 06/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cfbd472a4..2ae4f637f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # Gluon Scene Builder # [![Build](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml/badge.svg)](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml) -[![License](https://img.shields.io/github/license/gluonhq/scenebuilder)](https://opensource.org/licenses/GPL-3.0) +[![License](https://img.shields.io/badge/license-BSD-green)](./LICENSE) Scene Builder Kit: [![Maven Central](https://img.shields.io/maven-central/v/com.gluonhq.scenebuilder/kit)](https://search.maven.org/#search|ga|1|com.gluonhq.scenebuilder) From a67fbdf260ab65beef0b836c0943952deaa9451c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Pereda?= Date: Thu, 31 Oct 2024 19:07:10 +0100 Subject: [PATCH 07/11] Apply suggestions from code review Co-authored-by: Erwin Morrhey --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2ae4f637f..b5ba39383 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ These are the requisites: ### How to build Scene Builder ### -Scene Builder makes use of the Maven Wrapper to build and run the project. So there is no need to install Maven on the developers machine. To utilize Maven Wrapper, instead of calling `mvn`, one can run `./mvnw` on Linux or macOS or `mvnw` on Windows. +Scene Builder uses Maven Wrapper to build and run the project. Run `./mvnw` on Linux or macOS and `mvnw` on Windows. To build the Scene Builder services, on the project's root, run: @@ -101,13 +101,13 @@ Contains the JavaFX main application that embeds the Scene Builder Kit, and incl ### Scene Builder Kit ### -Scene Builder Kit is the core of the project, defines three main areas: +Scene Builder Kit is the core of the project and defines three main areas: - Left: Library of custom and built-in controls, Hierarchy and Controller of the FXML layout being edited - Center: Workspace area for displaying the content of the FXML layout that is being designed - Right: Inspector with properties, layout and event handlers of the components of the FXML layout. -Kit is an API that allows the integration of these components and their functionallity with other applications or IDEs, being Scene Builder App the best example of such integration. Other basic example can be found here: [EmbeddedSceneBuilderDemo](https://github.com/gluonhq/EmbeddedSceneBuilderDemo). Also you can use in your projects the controls available in Scene Builder Kit. +Scene Builder Kit contains an API that allows these components and their functionality to be integrated in other applications or IDEs. Scene Builder App is the best example of such integration. Another basic example can be found here: [EmbeddedSceneBuilderDemo](https://github.com/gluonhq/EmbeddedSceneBuilderDemo). You can also use the controls available in Scene Builder Kit in your project. Scene Builder Kit is published to Maven Central, and you can add it as a regular dependency to the build of your app: From b7c2106c8bfc44ac8df845bb6131946575fbf749 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Pereda?= Date: Thu, 31 Oct 2024 19:08:24 +0100 Subject: [PATCH 08/11] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b5ba39383..99a0dcf6b 100644 --- a/README.md +++ b/README.md @@ -70,11 +70,11 @@ It will create a partial shadow cross-platform jar under `app/target/lib/scenebu Before starting the app, all dependencies must be installed locally. This is achieved by: -`mvn install` +`./mvnw install` Then Scene Builder can be started with Maven: -`mvn javafx:run -f app` +`./wmvn javafx:run -f app` Alternatively, you can run the partial shadow jar in the classpath, providing you have downloaded the JavaFX SDK from [here](https://gluonhq.com/products/javafx/): @@ -121,7 +121,7 @@ Scene Builder Kit is published to Maven Central, and you can add it as a regular If you want to build and install the Scene Builder Kit in your local repository, run: -`mvn clean install -f kit` +`./mvnw clean install -f kit` ### Gluon plugin ### @@ -140,7 +140,7 @@ Contributors can check for code-style violations in their code by running the Ch To run the plugin: ``` -mvn checkstyle:checkstyle +./mvnw checkstyle:checkstyle ``` There will be a report for each sub-project: From 538e0c052d4af813c6c12c9e3829e54a12710a7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Pereda?= Date: Thu, 31 Oct 2024 20:16:10 +0100 Subject: [PATCH 09/11] Update README.md Co-authored-by: Erwin Morrhey --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 99a0dcf6b..1ae3f6f2e 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ This is achieved by: Then Scene Builder can be started with Maven: -`./wmvn javafx:run -f app` +`./mvnw javafx:run -f app` Alternatively, you can run the partial shadow jar in the classpath, providing you have downloaded the JavaFX SDK from [here](https://gluonhq.com/products/javafx/): From 1d980811aeec13c991643c1ca4b590c9dd581c2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Pereda?= Date: Mon, 4 Nov 2024 10:01:34 +0100 Subject: [PATCH 10/11] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ae3f6f2e..67ab25b4f 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ [![Build](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml/badge.svg)](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml) [![License](https://img.shields.io/badge/license-BSD-green)](./LICENSE) -Scene Builder Kit: +#### Scene Builder Kit #### + [![Maven Central](https://img.shields.io/maven-central/v/com.gluonhq.scenebuilder/kit)](https://search.maven.org/#search|ga|1|com.gluonhq.scenebuilder) [![javadoc](https://javadoc.io/badge2/com.gluonhq.scenebuilder/kit/javadoc.svg?color=blue)](https://javadoc.io/doc/com.gluonhq.scenebuilder/kit) From 8096892ae180a31e675ec909ff59a593e468cf89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Pereda?= Date: Mon, 4 Nov 2024 12:01:22 +0100 Subject: [PATCH 11/11] Change workflow --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 67ab25b4f..e0142045e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Gluon Scene Builder # -[![Build](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml/badge.svg)](https://github.com/gluonhq/scenebuilder/actions/workflows/build.yml) +[![Build](https://github.com/gluonhq/scenebuilder/actions/workflows/early-access.yml/badge.svg)](https://github.com/gluonhq/scenebuilder/actions/workflows/early-access.yml) [![License](https://img.shields.io/badge/license-BSD-green)](./LICENSE) #### Scene Builder Kit ####