From 0718b606e1ebf1c32c2a203b71b3d17353200891 Mon Sep 17 00:00:00 2001 From: Chris Lane Date: Sat, 7 Nov 2020 18:48:24 -0500 Subject: [PATCH] fix(README): clarify installation verbiage Update the installation verbiage in the `README` for clarity (issue #597). --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3c399aa..7aaa58b 100644 --- a/README.md +++ b/README.md @@ -47,17 +47,17 @@ Installing `cheat` has no dependencies. To install it, download the executable from the [releases][] page and place it on your `PATH`. +Alternatively, if you have [go][] installed, you may install `cheat` using `go +get`: + +```sh +go get -u github.com/cheat/cheat/cmd/cheat +``` Configuring ----------- ### conf.yml ### `cheat` is configured by a YAML file that will be auto-generated on first run. -Should you need to create a config file manually, you can do -so via: - -```sh -mkdir -p ~/.config/cheat && cheat --init > ~/.config/cheat/conf.yml -``` By default, the config file is assumed to exist on an XDG-compliant configuration path like `~/.config/cheat/conf.yml`. If you would like to store @@ -211,3 +211,4 @@ Additionally, `cheat` supports enhanced autocompletion via integration with [cheatsheets]: https://github.com/cheat/cheatsheets [completions]: https://github.com/cheat/cheat/tree/master/scripts [fzf]: https://github.com/junegunn/fzf +[go]: https://golang.org