diff options
| author | Teddy Wing | 2014-12-26 21:45:27 -0500 |
|---|---|---|
| committer | Teddy Wing | 2014-12-26 21:45:27 -0500 |
| commit | 2be3f192975944b7798ba0d4794af12101c2bcd0 (patch) | |
| tree | cb8b8a99a738121f1b8bc48bde295e7879a59dcd | |
| parent | 1ae327f46ccaf676acd6ae54eb00b9874609a87c (diff) | |
| download | git-checkout-history-2be3f192975944b7798ba0d4794af12101c2bcd0.tar.bz2 | |
README: Add installation instructions
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -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. |