Add easy build and execution instructions for developers

Author: Ayowel

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.

pom.xml

@@ -12,6 +12,7 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <asciidocfx.mainClass>com.kodedu.boot.AppStarter</asciidocfx.mainClass>
         <java.version>16</java.version>
         <maven.compiler.source>${java.version}</maven.compiler.source>
         <maven.compiler.target>${java.version}</maven.compiler.target>
@@ -23,6 +24,7 @@
         <jaxb.version>2.3.2</jaxb.version>
         <jacoco.version>0.8.7</jacoco.version>
         <logunit.version>1.1.0</logunit.version>
+        <javafx.scope>provided</javafx.scope>
     </properties>
 
     <organization>
@@ -224,25 +226,25 @@
             <groupId>org.openjfx</groupId>
             <artifactId>javafx-swing</artifactId>
             <version>${openjfx.version}</version>
-            <scope>provided</scope>
+            <scope>${javafx.scope}</scope>
         </dependency>
         <dependency>
             <groupId>org.openjfx</groupId>
             <artifactId>javafx-controls</artifactId>
             <version>${openjfx.version}</version>
-            <scope>provided</scope>
+            <scope>${javafx.scope}</scope>
         </dependency>
         <dependency>
             <groupId>org.openjfx</groupId>
             <artifactId>javafx-web</artifactId>
             <version>${openjfx.version}</version>
-            <scope>provided</scope>
+            <scope>${javafx.scope}</scope>
         </dependency>
         <dependency>
             <groupId>org.openjfx</groupId>
             <artifactId>javafx-fxml</artifactId>
             <version>${openjfx.version}</version>
-            <scope>provided</scope>
+            <scope>${javafx.scope}</scope>
         </dependency>
         <!-- Add test dependencies -->
         <dependency>
@@ -326,7 +328,7 @@
                 <configuration>
                     <programs>
                         <program>
-                            <mainClass>com.kodedu.boot.AppStarter</mainClass>
+                            <mainClass>${asciidocfx.mainClass}</mainClass>
                             <id>asciidocfx</id>
                         </program>
                     </programs>
@@ -492,6 +494,15 @@
                     </execution>
                 </executions>
             </plugin>
+              <!-- Easy launch in development -->
+            <plugin>
+                <groupId>org.openjfx</groupId>
+                <artifactId>javafx-maven-plugin</artifactId>
+                <version>0.0.6</version>
+                <configuration>
+                    <mainClass>${asciidocfx.mainClass}</mainClass>
+                </configuration>
+            </plugin>
         </plugins>
     </build>