From 2be3f192975944b7798ba0d4794af12101c2bcd0 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Fri, 26 Dec 2014 21:45:27 -0500 Subject: README: Add installation instructions --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 77a9c1b..bca61f8 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,17 @@ To make the tool easier to use, git aliases can be used: $ git chs a-branch +## Installation +Visit the [releases](https://github.com/teddywing/git-checkout-history/releases) page and download `git-checkout-history` and `git-checkout-store` for your platform. Put these binaries on your PATH and you should be able to run them using `git`. + +### Installing From Source +Run these commands to build `git-checkout-history` and `git-checkout-store`: + + $ go get github.com/teddywing/git-checkout-history + $ go install github.com/teddywing/git-checkout-history/git-checkout-history + $ go install github.com/teddywing/git-checkout-history/git-checkout-store + + ## Known Issues * Currently, branch history is stored globally. When used in multiple repositories, all branches go to the same list. There should be a different branch storage list for each repository. * History never gets cleared. Not sure if this is actually an issue, but personally I don't really care about branch history from before the current day. -- cgit v1.2.3