Native Messaging WIP -- install docs
authorBill Erickson <berickxx@gmail.com>
Thu, 10 Nov 2016 17:07:41 +0000 (12:07 -0500)
committerBill Erickson <berickxx@gmail.com>
Thu, 10 Nov 2016 17:07:41 +0000 (12:07 -0500)
Signed-off-by: Bill Erickson <berickxx@gmail.com>
README [deleted file]
README.linux [new file with mode: 0644]
README.win

diff --git a/README b/README
deleted file mode 100644 (file)
index 72a3f08..0000000
--- a/README
+++ /dev/null
@@ -1,19 +0,0 @@
-Hatch - Java Print / Storage / Etc Service
-
-** ROUGH SETUP NOTES **
-
-# download jdk1.8 (requires license agreement) -- haven't tested on openjdk yet. 
-# http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
-# and extract in the same directory
-% ln -s jdk1.8.0_25 jdk1.8
-
-% mkdir lib
-Download org.json jar from and place into lib (modify run.sh CP)
-https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.json%22%20AND%20a%3A%22json%22
-
-# compile
-% ./run.sh
-
-# compile + run
-% ./run.sh 1
-
diff --git a/README.linux b/README.linux
new file mode 100644 (file)
index 0000000..531a542
--- /dev/null
@@ -0,0 +1,37 @@
+Hatch - Java Print / Storage / Etc Service
+
+** ROUGH SETUP NOTES **
+
+1. Download JDK 8 from Oracle
+
+    1.a Go here, accept the license, and download the Linux .tar.gz:
+
+    http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+
+    1.b Extract the file and link it into place where run.sh can find it.
+
+    $ tar -zxf jdk*tar.gz
+    $ ln -s jdk1.8* jdk1.8
+
+    NOTE: We may some day use openjdk, but its JavaFX libs are not ready
+    for prime time as of writing.  
+
+2. Get the org.json library
+
+    $ mkdir lib
+    $ cd lib
+    $ wget -O json-20160810.jar \
+        'https://search.maven.org/remotecontent?filepath=org/json/json/20160810/json-20160810.jar'
+
+3. Compile and run.
+
+# compile
+$ ./run.sh complie
+
+# test
+$ ./run.sh test
+
+# run
+$ ./run.sh run
+
+
index 854a42e..a0dc37a 100644 (file)
@@ -2,6 +2,8 @@ Hatch - Java Print / Storage / Etc Service
 
 ** ROUGH SETUP NOTES **
 
+!!! TODO: refactor these for hatch-as-native-messaging-host changes !!!
+
 Install Hatch on your desktop -- Windows edition: 
 
 If you're reading this online, first download hatch to your desktop.