From e6cbd7b122f712a4fab5dbe7de73f4376f97a75b Mon Sep 17 00:00:00 2001 From: Daisuke Maki Date: Thu, 25 Oct 2018 09:18:30 +0900 Subject: [PATCH 1/2] Update README fixes #462 --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4ac9d17..cd47718 100644 --- a/README.md +++ b/README.md @@ -106,13 +106,32 @@ C:\> choco install peco ### Building peco yourself -From the root of your cloned peco repository, run: +Make sure to clone the source code under $GOPATH (i.e. $GOPATH/src/github.com/peco/peco). This is required +as the main binary refers to an internal package, which requires that the the source code be located in +the correct package location. + +Navigate to the directory above, then run: + +``` +make build +``` + +This will do the following: + +1. Install glide under `_internal_bin` directory +2. Run glide install to fetch dependencies +3. Run `go build` to create `releases/$VERSION_NUMBER/peco` + +You can copy the binary to some where in your $PATH, and it should just work. + +If you do not wish to have a separate installation of glide and/or want more control of the build process, +run the following instead: ``` glide install ``` -This installs the correct versions of peco's dependencies. Then build it: +The above installs the correct versions of peco's dependencies. Then build it: ``` go build cmd/peco/peco.go From eb778350a577e521284899070e71c07f0daca4e9 Mon Sep 17 00:00:00 2001 From: Daisuke Maki Date: Thu, 25 Oct 2018 22:57:41 +0900 Subject: [PATCH 2/2] typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cd47718..c706408 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@ This will do the following: 2. Run glide install to fetch dependencies 3. Run `go build` to create `releases/$VERSION_NUMBER/peco` -You can copy the binary to some where in your $PATH, and it should just work. +You can copy the binary to somewhere in your $PATH, and it should just work. If you do not wish to have a separate installation of glide and/or want more control of the build process, run the following instead: