Update README.md

README.md

@@ -1,4 +1,114 @@
-hello-javafx-maven-example
-==========================
+Hello JavaFX and Maven (Example Project)
+=========================================
+
+This is a simple "Hello World" example showing a ready to roll JavaFX project using the 
+<a href="https://github.com/zonski/javafx-maven-plugin">ZenJava JavaFX Maven plugin</a>. This can be downloaded 
+and used as a starter template for your own Maven JavaFX projects.
+
+The demonstration project includes a single module Maven project with example POM and source code. The POM is 
+configured to build both an executable JAR and a native installer (MSI, EXE, RPM, DMG) for your platform. 
+
+To demonstrate some Maven practices and benefits, the source code also includes a simple FXML example, style sheets, 
+images, and makes use of some third-party dependencies (such as Log4J, MigPane Layout, and Apache Commons). These 
+are all optional additions and included just to get you started. You can delete these references and add your own 
+as needed. 
+
+
+Setting up
+=========================================
+
+You must have a valid JDK installed with a valid JavaFX installation included in it (i.e. Java 1.7.0 update 9 or 
+higher). Make sure you have your JAVA_HOME set to this installation. See: http://www.oracle.com/technetwork/java/javase/downloads/index.html
+
+You must have Maven (3.0 or higher) installed on your system. See http://maven.apache.org/download.html
+
+To build the native installer for your application, you need to also install the relevant native installer library 
+used by JavaFX for your OS (e.g. on Windows, install WiX). See the JavaFX installation steps for info on 
+this: https://blogs.oracle.com/talkingjavadeployment/entry/native_packaging_for_javafx
+
+
+Get the Example Code
+=========================================
+
+Either: 
+
+1. Use GIT to checkout the sourcecode for this project to anywhere on your local directory, or  
+2. Download the ZIP file containing the project and extract anywhere on your local directory
+
+
+Fix the JRE Classpath to include JavaFX 
+=========================================
+
+Open a command line prompt and change directory to wherever you extracted the source code to, then type: 
+
+```
+    mvn jfx:fix-classpath
+```
+
+This only needs to be done once for each development machine. It will copy the JavaFX runtime into the JRE extension
+directory. For more information see: https://github.com/zonski/javafx-maven-plugin
+
+
+Build the Project 
+=========================================
+
+Use the standard Maven commands to compile and run your projects during development (e.g. clean, compile, install). Note
+that Maven will download a lot of third-party dependencies the first time it runs (meaning you don't have to). The first
+run can be slow but subsequent runs will be very fast. If you are new to Maven, see 
+http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html
+
+When you are ready to deploy your application use the standard Maven 'package' command: 
+
+```
+    mvn clean package
+```
+
+This will be quite slow (e.g. 30 seconds) as it is building the native co-bundled apps into an installer including all 
+third-party JARs.
+
+Once this command completes successfully you will find an executable JAR at: 
+
+```
+    {project.home}/target/javafx/your-app-name-jfx.jar
+```
+
+This JAR contains your complete application in one bundle and can be distributed directly, on its own (i.e. this one file
+can be copied to any machine that has Java installed and can then be double clicked to run your app).
+
+Additionally a native bundle will have been assembled in: 
+
+```
+    {project.home}/target/javafx/bundles
+```
+
+The exact format of the native bundle will depend on the OS you ran your build on i.e. if you built on Windows an MSI
+will have been created, if you built on Mac a RPM should be there). These bundles can be distributed as normal for that
+platform. 
+
+Note: currently it is not possible to build installers for other platforms than your current one so you have to run this
+build once on each platform you are targeting. This is a limitation of the JavaFX packaging tools and is not specific 
+to this Maven plugin (i.e. complain to the JavaFX guys, not me). 
+
+
+Make your own changes 
+=========================================
+
+To edit the source code you can just open the POM file (i.e. pom.xml) in the base directory of the project in most
+popular IDEs. IntelliJ supports the POM file out of the box. In Eclipse there is good support for Maven but you may
+have to install the plugin (I'm not sure). I believe NetBeans has some Maven support but I've never used it.
+
+This example project is provided as an example and as a base template for your own Maven and JavaFX projects. You are
+free to take the example project and change it as much as you like. You can delete everything that is there and start
+from scratch, or you can add to what's there. 
+
+You definitely should: 
+
+* Change the groupId in the pom.xml to use com.yourcompany instead of com.zenjava
+* Change the artifactId in the pom.xml to be your-project-name instead of hello-jfx-maven-example
+* Change the base package being use for the Java files to be com.yourcompany instead of com.zenjava
+
+If you don't have a company name, use a nickname or working name for yourself, e.g. com.yourname.
+
+
+
 
-Simple "Hello World" example showing a ready to roll JavaFX project using the ZenJava JavaFX Maven plugin. This can be downloaded and used as a starter template for your own Maven JavaFX projects.