From 81227fa2fba32d9e8a14d1de8c11d7405b320892 Mon Sep 17 00:00:00 2001 From: Luke Emmet Date: Fri, 21 Aug 2020 08:23:17 +0100 Subject: [PATCH] tweak readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2fb165a..255ea32 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ html2gmi ``` + ## Remarks linkEmitFrequency - this flag determines the frequency of the output of link lists. For example 1 means any links from the previous paragraph are emitted after each paragraph. 2, would mean they are emitted every two paragraphs and so on. Any gathered links are always emitted before a new heading. @@ -24,4 +25,21 @@ citationStart - this flag determines the start index of the links. By default th You can pipe content in from other applications, for example utilities that download HTML from the web. -To strip out cruft, you can use an HTML sanitiser before passing the content to this app. \ No newline at end of file +To strip out cruft, you can use an HTML sanitiser before passing the content to this app. + +## Building + +Compile using Go. + +Retrieve the package using Go get + +``` +go get github.com/LukeEmmet/html2gmi + +``` + +Build the binary using Go build + +``` +go build github.com/LukeEmmet/html2gmi +``` \ No newline at end of file