From 162006cbd66f433b9e7f6e7969658444088ed5c9 Mon Sep 17 00:00:00 2001 From: William Heng Date: Sun, 28 May 2017 23:27:00 +0100 Subject: [PATCH] Improve README, recommend installation through go get --- README.md | 25 +++++++------------------ 1 file changed, 7 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 5b2ae03..69e48da 100644 --- a/README.md +++ b/README.md @@ -6,31 +6,20 @@ This is a port of Kapeli's javadocset tool in Golang. I ported this tool as an e # Build Instructions ## Prerequisites -You need to have Go 1.8.3 and above to be able to compile this tool +You need to have Go 1.8.3 and above installed to be able to use this tool ## Instructions +It's as simple as: ``` -// Clone this repo -git clone https://github.com/william8th/javadocset - -// Change into the repo's directory -cd javadocset - -// Build the tool -go build - -// Run the javadocset tool -./javadocset - +go get github.com/william8th/javadocset ``` ## Usage ``` -./javadocset - -// where: -// = the name of the docset that will appear on Dash/Zeal -// = the folder containing the generated HTML Java doc +javadocset +# where: +# = the name of the docset that will appear on Dash/Zeal +# = the folder containing the generated HTML Java doc ``` # Credits