diff options
| author | Ben Morrison <ben@gbmor.dev> | 2019-06-12 05:27:18 -0400 |
|---|---|---|
| committer | Ben Morrison <ben@gbmor.dev> | 2019-06-12 05:27:18 -0400 |
| commit | b8561159e64e171790d8381e275cd24bcb99a58f (patch) | |
| tree | d824414dcb7fecd1bbb8d563fcf5b1d855c1085f | |
| parent | 99d2df63991069070c5c7434d42ffb968021bd14 (diff) | |
| download | getwtxt-b8561159e64e171790d8381e275cd24bcb99a58f.tar.gz | |
updated installation instructions
| -rw-r--r-- | README.md | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/README.md b/README.md index 2293421..76b5118 100644 --- a/README.md +++ b/README.md @@ -44,19 +44,34 @@ Build dependencies are minimal, and only include: * `go >= 1.11` * `git` -First, fetch the sources using `git` -and jump into the directory. Then, check out the latest tag. +First, fetch the sources using `git` and jump into the directory. ``` $ git clone git://github.com/getwtxt/getwtxt.git ... $ cd getwtxt -... +``` + +Then, check out the latest release tag. + +This will be the same tag listed on the badge under the [Features](#features) section heading. + +``` +$ git checkout v0.0.0 +``` + +Or, if you want to be a `git` ninja, you can use this to just check out whatever +the latest tag is: + +``` $ git checkout $(git describe --tags --abbrev=0) + ``` Optionally, use the `go` tool to test and benchmark the files in `svc`. -If you choose to run the tests, be sure to return to the main directory afterwards. + +If you choose to run the tests, be sure to return to the main directory +afterwards. ``` $ cd svc && go test -v -bench . -benchmem |