Merge pull request #265 from sifive/open-docs

Add make target to open local documentation

2 files changed, 29 insertions, 2 deletions

diff --git a/Makefile b/Makefile
index e742c35..39b4aed 100644
--- a/Makefile
+++ b/Makefile
@@ -100,8 +100,15 @@ help:
 	@echo "    Exports a program for a single target into a standalone"
 	@echo "    project directory at STANDALONE_DEST."
 	@echo ""
-	@echo " For more information, view the Freedom E SDK Documentation at"
-	@echo "   https://sifive.github.io/freedom-e-sdk-docs/index.html"
+	@echo " open-docs"
+	@echo "    Opens the Freedom E SDK documentation in your HTML"
+	@echo "    viewer of choice. The documentation can also be found"
+	@echo "    online at"
+	@echo "      https://sifive.github.io/freedom-e-sdk-docs/index.html"
+
+.PHONY: open-docs
+open-docs: scripts/open-docs
+	$^
 
 .PHONY: clean
 clean:
diff --git a/scripts/open-docs b/scripts/open-docs
new file mode 100755
index 0000000..82d0f91
--- /dev/null
+++ b/scripts/open-docs
@@ -0,0 +1,20 @@
+#!/usr/bin/env sh
+
+SDK_PATH="$( cd "$(dirname "$0")/.." ; pwd -P )"
+DOCS_PATH=$SDK_PATH/doc/html/index.html
+
+XDG_OPEN=`which xdg-open`
+OPEN=`which open`
+
+if [ "$XDG_OPEN" != "" ]; then
+        echo "Opening $DOCS_PATH"
+        $XDG_OPEN $DOCS_PATH
+
+elif [ "$OPEN" != "" ]; then
+        echo "Opening $DOCS_PATH"
+        $OPEN $DOCS_PATH
+
+else
+        echo "Please open $DOCS_PATH in your preferred HTML viewer"
+fi
+