Simplify and document CLI building steps

Gopkg.toml

@@ -1,29 +1,4 @@
-# Gopkg.toml example
-#
-# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
-# for detailed Gopkg.toml documentation.
-#
-# required = ["github.com/user/thing/cmd/thing"]
-# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
-#
-# [[constraint]]
-#   name = "github.com/user/project"
-#   version = "1.0.0"
-#
-# [[constraint]]
-#   name = "github.com/user/project2"
-#   branch = "dev"
-#   source = "github.com/myfork/project2"
-#
-# [[override]]
-#   name = "github.com/x/y"
-#   version = "2.4.0"
-#
-# [prune]
-#   non-go = false
-#   go-tests = true
-#   unused-packages = true
-
+required = ["github.com/golang/protobuf/protoc-gen-go"]
 
 [[constraint]]
   name = "github.com/ghodss/yaml"
@@ -49,10 +24,6 @@
   name = "github.com/spf13/viper"
   version = "1.2.1"
 
-[[constraint]]
-  branch = "master"
-  name = "golang.org/x/net"
-
 [[constraint]]
   name = "google.golang.org/grpc"
   version = "1.15.0"

cli/README.md

@@ -1,6 +1,7 @@
 # Feast CLI
 
-The feast command-line tool, `feast`, is used to register resources to feast, as well as manage and run ingestion jobs.
+The feast command-line tool, `feast`, is used to register resources to
+feast, as well as manage and run ingestion jobs.
 
 ## Installation
 
@@ -10,32 +11,39 @@ The quickest way to get the CLI is to download the compiled binary: #TODO
 
 ### Building from source
 
-The following dependencies are required to install the CLI from source:
-#### protoc
-To install protoc, find the compiled binary for your distribution [here](https://github.com/protocolbuffers/protobuf/releases), then install it:
-```
-PROTOC_VERSION=3.3.0
+The following dependencies are required to build the CLI from source:
+* [`go`](https://golang.org/)
+* [`protoc`](https://developers.google.com/protocol-buffers/)
+* [`dep`](https://github.com/golang/dep)
+
+See below for specific instructions on how to install the dependencies.
 
-curl -OL https://github.com/google/protobuf/releases/download/v$PROTOC_VERSION/$PROTOC_ZIP
-unzip -o $PROTOC_ZIP -d /usr/local bin/protoc
-rm -f $PROTOC_ZIP
+After the dependencies are installed, you can build the CLI using:
+```sh
+# at feast top-level directory
+$ make build-cli
 ```
 
-#### dep
-On MacOS you can install or upgrade to the latest released version with Homebrew:
+### Dependencies
 
-```
-brew install dep
-brew upgrade dep
-```
+#### `protoc-gen-go`
 
-On other platforms you can use the install.sh script:
-```
-curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
+To ensure you have a matching version of `protoc-gen-go`, install the vendored version:
+```sh
+$ go install  ./vendor/github.com/golang/protobuf/protoc-gen-go
+$ which protoc-gen-go
+~/go/bin/protoc-gen-go
 ```
 
-Then just install the cli using:
+#### `dep`
+
+On MacOS you can install or upgrade to the latest released version with Homebrew:
+```sh
+$ brew install dep
+$ brew upgrade dep
 ```
-# at feast top-level directory
-make install-cli
+
+On other platforms you can use the `install.sh` script:
+```sh
+$ curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
 ```