From b3e674db3c05ca586b159a71deb1b61d701ae5c9 Mon Sep 17 00:00:00 2001 From: "Field G. Van Zee" Date: Mon, 4 Apr 2022 17:31:02 -0500 Subject: [PATCH] README.md update to link to releases page. --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8b355470c..3803acdca 100644 --- a/README.md +++ b/README.md @@ -345,6 +345,18 @@ to executing the following command in your terminal shell: ``` git clone https://github.com/flame/blis.git ``` + At this point, you will have the latest commit of the `master` branch +checked out. If you wish to check out a particular version x.y.z, execute +the following: + ``` + git checkout x.y.z + ``` + `git` will then transform your working copy to match the state of the +commit associated with version x.y.z. You can view a list of tags at any +time by executing: + ``` + git tag --list + ``` 2. **Download a source repository via a zip file.** If you are uncomfortable with using `git` but would still like the latest @@ -356,8 +368,11 @@ This should reveal a link for downloading the zip file. 3. **Download a source release via a tarball/zip file.** Alternatively, if you would like to stick to the code that is included in -official releases, you may download either a tarball or zip file of any of -BLIS's previous [tagged releases](https://github.com/flame/blis/tags). +official releases, you may download either a tarball or zip file of BLIS's +latest [release](https://github.com/flame/blis/releases). Some older releases +are only available as [tagged](https://github.com/flame/blis/tags) commits. +(Note: downloading release x.y.z is equivalent to downloading, or checking out, +tag `x.y.z`.) We consider this option to be less than ideal for most people since it will likely mean you miss out on the latest bugfix or feature commits (in contrast to Options 1 or 2), and you also will not be able to update your code with a