Clarified documentation for build and execution

milux · Oct 31, 2018 · a2aadc3 · a2aadc3
1 parent 744bbe5
commit a2aadc3
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+### Version 1.0.1
+- Clarified documentation for build instructions
+
 ### Version 1.0
 - Initial version
 - Constants require adaptation for use
diff --git a/README.md b/README.md
@@ -9,10 +9,12 @@ Combined with a MIDI-capable light control system is meant to provide an "Ambili
 The tool was tested with **ProPresenter** background videos, **Native Instruments Komplete Audio 6** sound/MIDI interface and a **grandMA2 onPC** light control system.
 
 ## Requirements
-Java SE 8.0 or higher with `javax.sound.midi` available
+JDK 8.0 or higher with `javax.sound.midi` available
 
 ## Usage
-`java -jar ppcolor.jar`
+Build with `./gradlew jar proguard`
+
+Run with `java -jar ppcolor-<version>.jar`
 
 ## Output
 The program will print 2 Color values for every measurement:

diff --git a/build.gradle b/build.gradle
@@ -12,7 +12,7 @@ buildscript {
 }
 
 group 'ppcolor'
-version '1.0-SNAPSHOT'
+version '1.1-SNAPSHOT'
 
 apply plugin: 'kotlin'
 apply plugin: 'application'