Skip to content

Commit 5e92071

Browse files
Update README.md with latest changes (#83)
1 parent 7c3f772 commit 5e92071

File tree

1 file changed

+6
-52
lines changed

1 file changed

+6
-52
lines changed

README.md

Lines changed: 6 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -46,74 +46,28 @@ Add the plugin:
4646
</plugin>
4747
```
4848

49-
To compile the project (optional):
50-
51-
```
52-
mvn javafx:compile
53-
```
54-
55-
Alternatively, the `maven-compiler-plugin` can be used:
49+
Compile the project:
5650

5751
```
5852
mvn compile
5953
```
6054

61-
Note that including this plugin is convenient for a better
62-
project integration within your IDE.
55+
This step is optional and can be configured using the [maven-compiler-plugin](https://maven.apache.org/plugins/maven-compiler-plugin/).
6356

64-
To run the project:
57+
Run the project:
6558

6659
```
6760
mvn javafx:run
6861
```
6962

70-
For modular projects, to create and run a custom image:
63+
For modular projects, create and run a custom image:
7164

7265
```
7366
mvn javafx:jlink
7467
7568
target/image/bin/java -m hellofx/org.openjfx.App
7669
```
7770

78-
### javafx:compile options
79-
80-
When compiling with ``javafx:compile``, the source level,
81-
target level and/or the release level for the Java compiler can be set.
82-
The default value is 11.
83-
84-
This configuration changes these levels to 12, for instance:
85-
86-
```
87-
<plugin>
88-
<groupId>org.openjfx</groupId>
89-
<artifactId>javafx-maven-plugin</artifactId>
90-
<version>0.0.5</version>
91-
<configuration>
92-
<source>12</source>
93-
<target>12</target>
94-
<release>12</release>
95-
<mainClass>org.openjfx.hellofx/org.openjfx.App</mainClass>
96-
</configuration>
97-
</plugin>
98-
```
99-
100-
If required, compiler arguments can be set. For instance:
101-
102-
```
103-
<plugin>
104-
<groupId>org.openjfx</groupId>
105-
<artifactId>javafx-maven-plugin</artifactId>
106-
<version>0.0.5</version>
107-
<configuration>
108-
<compilerArgs>
109-
<arg>--add-exports</arg>
110-
<arg>javafx.graphics/com.sun.glass.ui=org.openjfx.hellofx</arg>
111-
</compilerArgs>
112-
<mainClass>org.openjfx.hellofx/org.openjfx.App</mainClass>
113-
</configuration>
114-
</plugin>
115-
```
116-
11771
### javafx:run options
11872

11973
The plugin includes by default: `--module-path`, `--add-modules` and `-classpath` options.
@@ -123,7 +77,7 @@ Optionally, the configuration can be modified with:
12377
- `mainClass`: The main class, fully qualified name, with or without module name
12478
- `workingDirectory`: The current working directory
12579
- `skip`: Skip the execution. Values: false (default), true
126-
- `outputFile` File to redirect the process output
80+
- `outputFile`: File to redirect the process output
12781
- `options`: A list of VM options passed to the executable.
12882
- `commandlineArgs`: Arguments separated by space for the executed program
12983
- `includePathExceptionsInClasspath`: When resolving the module-path, setting this value to true will include the
@@ -223,7 +177,7 @@ For instance, with the following configuration:
223177
</plugin>
224178
```
225179

226-
a custom image can be created and run as:
180+
A custom image can be created and run as:
227181

228182
```
229183
mvn clean javafx:jlink

0 commit comments

Comments
 (0)