Updating readme, adding scripts.

Author: John Donovan

README.md

@@ -1,6 +1,5 @@
 Using `pmbuilder` and `pmextractor`
 ============
-__*NOTE*:This README is a work in progress.__
 
 ## About
 
@@ -36,7 +35,7 @@ folders. The lib folder contains reusable javascript files.
 ```
 
 ## Getting Started
-Pick up the latest release here.
+[Pick up the latest release here.](https://github.com/AppXpress/PlatformModuleBuilder/releases/latest) Or build from source!
 
 ### Installing
 After downloading the latest release, `pmbuilder` and `pmextractor` need to be added to your path, or put in a directory that is in already on your path.
@@ -70,25 +69,39 @@ in the src/PM_Builder and src/PM_extractor folders respectively. Steps to build
 
 #### Building From Eclipse
 
+After importing project to eclipse:
+1. File -> Export
+2. Java -> Runnable jar
+3. Ensure that "Extract required libraries into generated JAR" is selected.
+4. Finish
 
-## Running `pmbuilder`
+## Running `pmbuilder` and `pmexractor`
 
-`pmbuilder` should be run in its own folder. This folder should contain `pmbuilder`Util.
-`pmbuilder`Util.jar is found in this repository. `pmbuilder` uses Git, so Git must be
-installed but no knowledge of Git is required to run the script. It is important to note
-that `pmbuilder` should not be run in the same folder as your local git working directory, as
-it could cause conflicts. The script is standalone, and will re pull changes from git every
-time it runs.
+Running either tool is easy. For example:
 
 ```bash
 $ `pmbuilder`
 ```
+When running either tool as above, first the properties files are read.
+If any necessary values are missing you will be prompted for them. It is important
+that you are careful when running the tool like this.
 
+Command line options take precedence over the properties file. To display what options
+a tool takes pass the `-help` option.
 
+```bash
+$ pmbuilder -help
+```
+
+### Understanding the Options
+The options that are common between `pmextractor` and `pmbuilder` adhere to the aforementioned git structure, and can be used to build the absolute path to a module.
+```
+${localDir}/${customer}/${platform}
+```
 
 ### Using PM Builder's Import Utility
 
-The `pmbuilder`Util.jar can add common files to any folder in your file structure. Use ->
+The `pmbuilder`Util.jar can add common files to any folder in your file structure. Use :
 
 ```javascript
 !import commonFile.js
@@ -126,72 +139,13 @@ function myFunction () {
 //!import example.js
 ```
 
-*Note:* The import utility does not continue to look for `!import` statement
+<b>*Note:*</b> The import utility does not continue to look for `!import` statement
 once the top comment has ended in order to run more efficiently. Therefore,
 any text not in a comment will cause the scanner to end looking at a
 particular script.
 
-### Options
-
-The following options can be set to run with `pmbuilder`
-
-```
--h		displays options on how to set the property file
-
--f		sets platform module folder
-
--c 		set customer
-
--b 		set branch to pull from repository
-
-```
-
-## Running `pmextractor`
-
-`pmextractor` is a bash that automates the process of exporting a custom module
-and merging with your local working directory. `pmextractor` backs up the current
-working directory before the merge and supplies two options, overWrite Fef and
-overWrite scripts. Currently, the bash script will prompt you for a **y** or **n**
-to both options. `pmextractor` must be run in a place where it can access your
-local directory and exported platform module.
-
-`pmextractor` similarly has a property file that stores the working directory, the
-name of the exported platform module, the platform module folder, and the customers
-name. `pmextractor` is following the same structure as the one found in stash pso/platform.
-Enter `bash `pmextractor` -h` to view various options in setting or clearing the property
-file.
-
-### Options
-
-The following options can be set to run with `pmextractor`
-
-```
--h		displays options on how to set the property file
-
--o		sets the script to overwrite FEF and scripts
-
--f		sets the script to overwrite FEF
-
--s		sets the script to overwrite scripts
-
--i 		sets the script to not overwrite FEF or scripts
-
--g		set git local directory
-
--p      set platform folder name
-
--c      set customer folder name
-
--z      set exported zip folder name
-
-```
-
-## `pmbuilder` and `pmextractor's` Properties File
+Contributing
+============
 
-Both scripts allow for quick reuse by supplying a property file. The extractor's
-property file can store exported folder name, local directory name, customer name,
-and platform module name. The builder's property file can store repository url, repository
-branch, customer name, and platform module name. The property files are called builder.properties
-and extractor.properties and can be found in your home /.platformtools folder. For each ,
-Run -> `bash `pmbuilder` -help` or `bash `pmextractor` -help` to view the
-different options for each respective script.
+To contribute or ask a question, please open an issue with the appropriate tag,
+or feel free to submit a pull request!

scripts/pmbuilder

@@ -0,0 +1,8 @@
+#!/bin/sh
+source ~/.profile
+if [ -z "$APPXPRESS_HOME" ]; then
+  echo "APPXPRESS_HOME is not set. Aborting build."
+  exit 0;
+fi;
+java -cp $APPXPRESS_HOME/pmbuilder.jar \
+  com.gtnexus.appxpress.pmbuilder.PlatformModuleBuilder "$@"

scripts/pmextractor

@@ -0,0 +1,8 @@
+#!/bin/sh
+source ~/.profile
+if [ -z "$APPXPRESS_HOME" ]; then
+  echo "APPXPRESS_HOME is not set. Aborting build."
+  exit 0;
+fi;
+java -cp $APPXPRESS_HOME/pmbuilder.jar \
+  com.gtnexus.appxpress.pmextractor.PlatformModuleExtractor "$@"