Updated installation instructions

psidnell · Jan 4, 2015 · 0bbbda7 · 0bbbda7
1 parent 234475c
commit 0bbbda7
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,5 @@ target
 .project
 .pydevproject
 ofexport2.bbprojectd
+.idea
+*.iml
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -43,6 +43,8 @@
     - [ofexport vs ofexport2](DOCUMENTATION.md#ofexport-vs-ofexport2)
     - [Other Approaches Considered](DOCUMENTATION.md#other-approaches-considered)
     - [Known Issues](DOCUMENTATION.md#known-issues)
+- [FAQ](FAQ.md#faq)
+    - [Exception in thread "main" java.lang.UnsupportedClassVersionError](FAQ.md#exception-in-thread-"main"-java.lang.unsupportedclassversionerror)
 
 ## Overview
 
@@ -99,17 +101,19 @@ Currently supported export formats are:
 
 The key technologies used for the transformation are:
 
-1. [Java 8](https://java.com/en/download/index.jsp) for the main command line program.
+1. [Java SE 8 JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html) for the main command line program.
 2. [OGNL](http://commons.apache.org/proper/commons-ognl/) for specifying filters and sorting.
 3. [FreeMarker](http://http://freemarker.org) for the templates to provide the output.
 
 ## Installation
 
 Installation is entirely manual and done from the command line. Essentially you will be downloading/unpacking the zip and adding it's bin directory to your path.
 
-**1. You should have Java 8 already installed:**
+**1. You should have the Java 8 SDK already installed:**
 
-You can verify this by typing:
+The Java SE 8 JDK can be found [here](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
+
+You can verify it is installed by typing:
 
     java -version
 
@@ -119,6 +123,8 @@ You should see output similar to:
     Java(TM) SE Runtime Environment (build 1.8.0_25-b17)  
     Java HotSpot(TM) 64-Bit Server VM (build 25.25-b02, mixed mode)  
 
+If after installing the Java 8 JDK you still see a different version, you may have multiple versions of java installed.
+
 **2. Download:**
 
 To get the required files, either:

diff --git a/FAQ.md b/FAQ.md
@@ -0,0 +1,23 @@
+[Home](README.md) | [Release Notes](RELEASE-NOTES.md) | [Support](SUPPORT.md) | [Documentation](DOCUMENTATION.md)
+
+# FAQ
+
+## Exception in thread "main" java.lang.UnsupportedClassVersionError
+
+Caused by having the wrong or multiple versions of java.
+
+Try adding the following to your .bash_profile file:
+
+    export JAVA_HOME=`/usr/libexec/java_home -v 1.8`
+
+Details [here](https://github.com/psidnell/ofexport2/issues/4).
+
+## java -version shows an older version of java
+
+Caused by having the wrong or multiple versions of java.
+
+Try adding the following to your .bash_profile file:
+
+    export JAVA_HOME=`/usr/libexec/java_home -v 1.8`
+
+Details [here](https://github.com/psidnell/ofexport2/issues/4).
diff --git a/README.md b/README.md
@@ -58,4 +58,6 @@ Export from OmniFocus to various other formats:
     - [ofexport vs ofexport2](DOCUMENTATION.md#ofexport-vs-ofexport2)
     - [Other Approaches Considered](DOCUMENTATION.md#other-approaches-considered)
     - [Known Issues](DOCUMENTATION.md#known-issues)
+- [FAQ](FAQ.md#faq)
+    - [Exception in thread "main" java.lang.UnsupportedClassVersionError](FAQ.md#exception-in-thread-"main"-java.lang.unsupportedclassversionerror)
 
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -2,6 +2,7 @@
 
 # Support
 
+- [FAQ](FAQ.md)
 - [Open a Bug](https://github.com/psidnell/ofexport2/issues)
 - [Blog: Poor Signal](http://poor-signal.blogspot.co.uk)
 - [Twitter: @psidnell](http://twitter.com/psidnell)
diff --git a/TOC.md b/TOC.md
@@ -39,4 +39,6 @@
     - [ofexport vs ofexport2](DOCUMENTATION.md#ofexport-vs-ofexport2)
     - [Other Approaches Considered](DOCUMENTATION.md#other-approaches-considered)
     - [Known Issues](DOCUMENTATION.md#known-issues)
+- [FAQ](FAQ.md#faq)
+    - [Exception in thread "main" java.lang.UnsupportedClassVersionError](FAQ.md#exception-in-thread-"main"-java.lang.unsupportedclassversionerror)
 
diff --git a/build/generate-toc.sh b/build/generate-toc.sh
@@ -2,9 +2,9 @@
 
 set -e
 
-python build/mdtoc.py README.md RELEASE-NOTES.md SUPPORT.md DOCUMENTATION.md | egrep '\[Table Of Contents' -v > TOC.md
+python build/mdtoc.py README.md RELEASE-NOTES.md SUPPORT.md DOCUMENTATION.md FAQ.md | egrep '\[Table Of Contents' -v > TOC.md
 
-for FILE in README.md DOCUMENTATION.md;do
+for FILE in README.md DOCUMENTATION.md FAQ.md;do
 	python build/mdinsert.py TOC.md $FILE '^## Table Of Contents' '^#' > .tmp
 	cp .tmp $FILE
 	rm .tmp