Remove install.sh; add make install target

bryphe-coder · bryphe-coder · commit 0b16731c9f05 · 2022-02-11T00:27:52.000Z
diff --git a/Makefile b/Makefile
@@ -1,3 +1,5 @@
+INSTALL_DIR=$(shell go env GOPATH)/bin
+
 bin/coder:
 	mkdir -p bin
 	go build -o bin/coder cmd/coder/main.go
@@ -51,6 +53,12 @@ fmt: fmt/prettier fmt/sql
 gen: database/generate peerbroker/proto provisionersdk/proto provisionerd/proto
 .PHONY: gen
 
+install: 
+	@echo "--- Copying from bin to $(INSTALL_DIR)"
+	cp -r ./bin $(INSTALL_DIR)
+	@echo "-- CLI available at $(INSTALL_DIR)/coder"
+.PHONY: install
+
 peerbroker/proto: peerbroker/proto/peerbroker.proto
 	protoc \
 		--go_out=. \
diff --git a/README.md b/README.md
@@ -15,6 +15,12 @@ This repository contains source code for Coder V2. Additional documentation:
 
 ## Development
 
+### Pre-requisites
+
+- `git` installed
+- `node` and `yarn` installed
+- `go` version 1.17, with the `GOPATH` environment variable set
+
 ### Cloning
 
 - `git clone https://github.com/coder/coder`
@@ -23,18 +29,16 @@ This repository contains source code for Coder V2. Additional documentation:
 ### Building
 
 - `make build`
+- `make install`
+
+The `coder` CLI binary will now be available at `$GOPATH/bin/coder`
 
 ### Development
 
 - `./develop.sh`
 
 The `develop.sh` script runs the server locally on port `3000`, and runs a hot-reload server for front-end code on `8080`.
 
-### CLI
-
-- `./install.sh` will `go install` the `coder` CLI
-- `coder --help`
-
 ## Front-End Plan
 
 For the front-end team, we're planning on 2 phases to the 'v2' work:
diff --git a/install.sh b/install.sh
