diff --git a/README.md b/README.md index c54c003..c94acd1 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,12 @@ The data entry automator is a tool that allows you to automate the process of en The program can currently be run from either the command line or via a GUI. ### Running the Program -##### Not Recommended +#### Not Recommended Run the program using the following command: ```bash java -jar data-entry-automator.jar -i [options] ``` - -##### Recommended -Run the program by installing the app using one of releases on the (releases)[https://github.com/AdamW78/Data-Entry-Automator/releases] page. Once installed, navigate to the install location (or create a desktop shortcut) and open the application to access the GUI. The program should look something like: - -#### Options +##### Options | Argument | Short Form | Usage | Description | Default Value | |-----------------|------------|------------------------|---------------------------------------------------------------|---------------------------------------| @@ -29,6 +25,11 @@ Run the program by installing the app using one of releases on the (releases)[ht | `--verbose` | `-v` | `--verbose` | Whether or not verbose output should be printed | `false` | | `--help` | `-h` | `--help` | Whether or not helpful usage information should be printed | `false` | + +#### Recommended +Run the program by installing the app using one of releases on the [releases](https://github.com/AdamW78/Data-Entry-Automator/releases) page. Once installed, navigate to the installation location (or create a desktop shortcut) and open the application to access the GUI. The program should look something like: +![GUI Example](images/GUI_screenshot.png) + ### Input The input to the data entry automator is a `.xlsx` file with the following columns: - `Strain`: The name of the strain diff --git a/build.gradle b/build.gradle index 6bf877b..0d55b63 100644 --- a/build.gradle +++ b/build.gradle @@ -15,7 +15,7 @@ jlink { name = 'DataEntryAutomation' jpackage { imageName = 'Data Entry Automator' - skipInstaller = true + // skipInstaller = true outputDir = "${layout.buildDirectory.get().asFile}" vendor = "Adam Wojciak" appVersion = project.version diff --git a/images/GUI_screenshot.png b/images/GUI_screenshot.png new file mode 100644 index 0000000..d0c8a1f Binary files /dev/null and b/images/GUI_screenshot.png differ