diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca1901de7..d003cd8a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,6 +15,12 @@ We welcome any type of contribution, not only code. You can help with Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). +## Getting started with the code + +To start development of a new feature or fix, check out the repository with Git and start editing the code in your favorite IDE. + +Once you're done editing, you will need a Java 16 JDK as well as Maven to build and run the code. Ensure that the `JAVA_HOME` environment variable is set to your Java 16 JDK path and run the following command to build and execute Asciidocfx: `mvn clean javafx:run -Djavafx.scope=compile` + ## Submitting code Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests. diff --git a/pom.xml b/pom.xml index 57eb35de0..4376147c4 100644 --- a/pom.xml +++ b/pom.xml @@ -12,6 +12,7 @@ UTF-8 + com.kodedu.boot.AppStarter 16 ${java.version} ${java.version} @@ -23,6 +24,96 @@ 2.3.2 0.8.7 1.1.0 + provided + + --module-path jmods + --add-modules=ALL-MODULE-PATH + --add-modules=javafx.controls,javafx.fxml,javafx.graphics,javafx.media,javafx.swing,javafx.web + + + --add-exports + javafx.graphics/com.sun.javafx.scene.layout=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.util=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.application=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.sg.prism=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.scene=ALL-UNNAMED + --add-exports + javafx.base/com.sun.javafx.logging=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.prism=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.glass.ui=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.geom.transform=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.tk=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.glass.utils=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.font=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.scene.input=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.scene.text=ALL-UNNAMED + --add-exports + javafx.base/com.sun.javafx.event=ALL-UNNAMED + --add-exports + javafx.base/com.sun.javafx.reflect=ALL-UNNAMED + --add-exports + javafx.base/com.sun.javafx.beans=ALL-UNNAMED + --add-exports + javafx.base/com.sun.javafx.collections=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.scene.traversal=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.stage=ALL-UNNAMED + --add-exports + javafx.base/com.sun.javafx.binding=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.geom=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.iio=ALL-UNNAMED + --add-exports + javafx.base/com.sun.javafx=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.prism.paint=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.scenario.effect=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.text=ALL-UNNAMED + --add-opens + javafx.base/com.sun.javafx.collections=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.scenario.effect.impl.prism=ALL-UNNAMED + --add-exports + javafx.graphics/com.sun.javafx.css=ALL-UNNAMED + --add-opens + javafx.base/com.sun.javafx.collections=javafx.web + --add-opens + javafx.controls/javafx.scene.control=ALL-UNNAMED + --add-exports + javafx.base/com.sun.javafx.property=ALL-UNNAMED + --add-exports + javafx.controls/com.sun.javafx.scene.control=ALL-UNNAMED + + + -Duser.language=en + -Duser.country=US + -Dfile.encoding=UTF-8 + -Xms128M + -Xmx756M + -Djava.awt.headless=false + --illegal-access=permit + + + ${project.jvmArgs.base} + ${javafx.jvmArgs.exports} + ${javafx.jvmArgs.modules} + @@ -224,25 +315,25 @@ org.openjfx javafx-swing ${openjfx.version} - provided + ${javafx.scope} org.openjfx javafx-controls ${openjfx.version} - provided + ${javafx.scope} org.openjfx javafx-web ${openjfx.version} - provided + ${javafx.scope} org.openjfx javafx-fxml ${openjfx.version} - provided + ${javafx.scope} @@ -326,90 +417,11 @@ - com.kodedu.boot.AppStarter + ${asciidocfx.mainClass} asciidocfx - - -Duser.language=en - -Duser.country=US - -Dfile.encoding=UTF-8 - -Xms128M - -Xmx756M - -Djava.awt.headless=false - --illegal-access=permit - --add-exports - javafx.graphics/com.sun.javafx.scene.layout=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.util=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.application=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.sg.prism=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.scene=ALL-UNNAMED - --add-exports - javafx.base/com.sun.javafx.logging=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.prism=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.glass.ui=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.geom.transform=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.tk=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.glass.utils=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.font=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.scene.input=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.scene.text=ALL-UNNAMED - --add-exports - javafx.base/com.sun.javafx.event=ALL-UNNAMED - --add-exports - javafx.base/com.sun.javafx.reflect=ALL-UNNAMED - --add-exports - javafx.base/com.sun.javafx.beans=ALL-UNNAMED - --add-exports - javafx.base/com.sun.javafx.collections=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.scene.traversal=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.stage=ALL-UNNAMED - --add-exports - javafx.base/com.sun.javafx.binding=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.geom=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.iio=ALL-UNNAMED - --add-exports - javafx.base/com.sun.javafx=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.prism.paint=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.scenario.effect=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.text=ALL-UNNAMED - --add-opens - javafx.base/com.sun.javafx.collections=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.scenario.effect.impl.prism=ALL-UNNAMED - --add-exports - javafx.graphics/com.sun.javafx.css=ALL-UNNAMED - --add-opens - javafx.base/com.sun.javafx.collections=javafx.web - --add-opens - javafx.controls/javafx.scene.control=ALL-UNNAMED - --add-exports - javafx.base/com.sun.javafx.property=ALL-UNNAMED - --add-exports - javafx.controls/com.sun.javafx.scene.control=ALL-UNNAMED - --module-path jmods - --add-modules=ALL-MODULE-PATH - --add-modules=javafx.controls,javafx.fxml,javafx.graphics,javafx.media,javafx.swing,javafx.web - + ${project.jvmArgs} flat @@ -492,6 +504,16 @@ + + + org.openjfx + javafx-maven-plugin + 0.0.6 + + ${asciidocfx.mainClass} + ${project.jvmArgs.base} ${javafx.jvmArgs.exports} + +