Skip to content

Commit ad3003e

Browse files
jperedadnrerwin1
andauthored
docs: Update README.md (#792)
* Update README.md * add javadoc badge * Update README.md * Update README.md * add logo * Update README.md * Apply suggestions from code review Co-authored-by: Erwin Morrhey <[email protected]> * Update README.md * Update README.md Co-authored-by: Erwin Morrhey <[email protected]> * Update README.md * Change workflow --------- Co-authored-by: Erwin Morrhey <[email protected]>
1 parent bef255f commit ad3003e

File tree

2 files changed

+240
-10
lines changed

2 files changed

+240
-10
lines changed

.github/assets/gluon_logo.svg

Lines changed: 195 additions & 0 deletions
Loading

README.md

Lines changed: 45 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1+
[![Gluon](.github/assets/gluon_logo.svg)](https://gluonhq.com)
2+
13
# Gluon Scene Builder #
24

5+
[![Build](https://github.com/gluonhq/scenebuilder/actions/workflows/early-access.yml/badge.svg)](https://github.com/gluonhq/scenebuilder/actions/workflows/early-access.yml)
6+
[![License](https://img.shields.io/badge/license-BSD-green)](./LICENSE)
7+
8+
#### Scene Builder Kit ####
9+
10+
[![Maven Central](https://img.shields.io/maven-central/v/com.gluonhq.scenebuilder/kit)](https://search.maven.org/#search|ga|1|com.gluonhq.scenebuilder)
11+
[![javadoc](https://javadoc.io/badge2/com.gluonhq.scenebuilder/kit/javadoc.svg?color=blue)](https://javadoc.io/doc/com.gluonhq.scenebuilder/kit)
12+
313
Gluon [Scene Builder](http://gluonhq.com/products/scene-builder/) is a drag and drop UI designer tool allowing rapid desktop and mobile app development.
414
Scene Builder separates design from logic, allowing team members to quickly and easily focus on their specific aspect of application development.
515

@@ -44,7 +54,7 @@ These are the requisites:
4454

4555
### How to build Scene Builder ###
4656

47-
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.
57+
Scene Builder uses Maven Wrapper to build and run the project. Run `./mvnw` on Linux or macOS and `mvnw` on Windows.
4858

4959
To build the Scene Builder services, on the project's root, run:
5060

@@ -61,11 +71,11 @@ It will create a partial shadow cross-platform jar under `app/target/lib/scenebu
6171
Before starting the app, all dependencies must be installed locally.
6272
This is achieved by:
6373

64-
`mvn install`
74+
`./mvnw install`
6575

6676
Then Scene Builder can be started with Maven:
6777

68-
`mvn javafx:run -f app`
78+
`./mvnw javafx:run -f app`
6979

7080
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/):
7181

@@ -78,14 +88,29 @@ java \
7888
com.oracle.javafx.scenebuilder.app.SceneBuilderApp
7989
```
8090

81-
## Scene Builder Kit ##
91+
## Scene Builder components ##
92+
93+
The Scene Builder project has three main components defined by three modules (that is, three Java modules defined in three Maven modules subprojects):
94+
95+
- Scene Builder App
96+
- Scene Builder Kit
97+
- Gluon plugin
98+
99+
### Scene Builder App ###
100+
101+
Contains the JavaFX main application that embeds the Scene Builder Kit, and includes menus, preferences and dialogs to interact with it.
82102

83-
To build and install the Scene Builder Kit in your local repository, run:
103+
### Scene Builder Kit ###
84104

85-
`mvn clean install -f kit`
105+
Scene Builder Kit is the core of the project and defines three main areas:
86106

87-
The custom controls of the Scene Builder kit can be used in your project.
88-
You can add it as a regular dependency to the build of your app:
107+
- Left: Library of custom and built-in controls, Hierarchy and Controller of the FXML layout being edited
108+
- Center: Workspace area for displaying the content of the FXML layout that is being designed
109+
- Right: Inspector with properties, layout and event handlers of the components of the FXML layout.
110+
111+
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.
112+
113+
Scene Builder Kit is published to Maven Central, and you can add it as a regular dependency to the build of your app:
89114

90115
```
91116
<dependency>
@@ -95,6 +120,16 @@ You can add it as a regular dependency to the build of your app:
95120
</dependency>
96121
```
97122

123+
If you want to build and install the Scene Builder Kit in your local repository, run:
124+
125+
`./mvnw clean install -f kit`
126+
127+
### Gluon plugin ###
128+
129+
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.
130+
131+
An easy way to get started is by selecting the Mobile Basic Screen from the available templates in the welcome dialog.
132+
98133
## Code Style
99134

100135
To ensure that new code formatting matches the requirements for Pull Requests,
@@ -106,10 +141,10 @@ Contributors can check for code-style violations in their code by running the Ch
106141
To run the plugin:
107142

108143
```
109-
mvn checkstyle:checkstyle
144+
./mvnw checkstyle:checkstyle
110145
```
111146

112-
There will be a report for each sub-project, one for `app` and one for `kit`.
147+
There will be a report for each sub-project:
113148

114149
* Kit: `kit/target/reports/checkstyle.html`
115150
* App: `app/target/reports/checkstyle.html`

0 commit comments

Comments
 (0)