summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorNick White <git@njw.name>2020-11-06 16:44:42 +0000
committerNick White <git@njw.name>2020-11-06 16:44:42 +0000
commite9f6e6546ba6f8039897fe8e4396858f300af217 (patch)
tree31f914aa7031792985a7efb906beac63eba4d8a7 /README
parentf706e96cb59d5548ed5afbbf1991dc442b8ffc09 (diff)
Add git clone advice to readme
Diffstat (limited to 'README')
-rw-r--r--README5
1 files changed, 5 insertions, 0 deletions
diff --git a/README b/README
index 6829c1c..2f1a95a 100644
--- a/README
+++ b/README
@@ -9,6 +9,11 @@ by running `go get rescribe.xyz/bookpipeline/...` and documentation
can be read with the `go doc` command or online at
<https://pkg.go.dev/rescribe.xyz/bookpipeline>.
+If you just want to install and use the commands, you can get the
+package with `git clone https://git.rescribe.xyz/bookpipeline`, and
+then install them with `go install ./...` from within the
+`bookpipeline` directory.
+
## Commands
The commands in the cmd/ directory are at the heart of this