From b8c89cd63ca413bcce3a217779d8fb2f7aabc62a Mon Sep 17 00:00:00 2001
From: Kristoffer Dalby <kradalby@kradalby.no>
Date: Tue, 26 Oct 2021 20:53:10 +0000
Subject: [PATCH] Add readme and makefile entry about code generation

---
 Makefile  |  5 ++++-
 README.md | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index 755253f..4c1d613 100644
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,7 @@
 # Calculate version
 version = $(shell ./scripts/version-at-commit.sh)
 
-build:
+build: generate
 	go build -ldflags "-s -w -X github.com/juanfont/headscale/cmd/headscale/cli.Version=$(version)" cmd/headscale/headscale.go
 
 dev: lint test build
@@ -25,3 +25,6 @@ lint:
 compress: build
 	upx --brute headscale
 
+generate:
+	rm -rf gen
+	buf generate proto
diff --git a/README.md b/README.md
index 91e13b9..4e37331 100644
--- a/README.md
+++ b/README.md
@@ -60,6 +60,41 @@ Please have a look at the documentation under [`docs/`](docs/).
 1. We have nothing to do with Tailscale, or Tailscale Inc.
 2. The purpose of writing this was to learn how Tailscale works.
 
+## Contributing
+
+To contribute to Headscale you would need the lastest version of [Go](golang.org) and [Buf](https://buf.build)(Protobuf generator).
+
+### Install development tools
+
+- Go
+- Buf
+- Protobuf tools:
+
+```shell 
+go install \
+    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
+    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
+    google.golang.org/protobuf/cmd/protoc-gen-go \
+    google.golang.org/grpc/cmd/protoc-gen-go-grpc
+```
+
+Building the project requires the generation of Go code from Protobuf (in `proto/`) and it can be (re-)generated with:
+
+```shell
+make generate
+```
+
+To run the tests:
+
+```shell
+make test
+```
+
+To build the program:
+
+```shell
+make build
+```
 
 ## Contributors