Browse Source

Improve README, recommend installation through go get

master
William Heng 8 years ago
parent
commit
162006cbd6
  1. 25
      README.md

25
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 # Build Instructions
## Prerequisites ## 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 ## Instructions
It's as simple as:
``` ```
// Clone this repo go get github.com/william8th/javadocset
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
``` ```
## Usage ## Usage
``` ```
./javadocset <docset name> <Javadoc folder> javadocset <docset name> <Javadoc folder>
# where:
// where: # <docset name> = the name of the docset that will appear on Dash/Zeal
// <docset name> = the name of the docset that will appear on Dash/Zeal # <Javadoc folder> = the folder containing the generated HTML Java doc
// <Javadoc folder> = the folder containing the generated HTML Java doc
``` ```
# Credits # Credits

Loading…
Cancel
Save