From 124d8a342464f4dec86f59c1a74140071466ccc8 Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Mon, 7 Mar 2022 16:58:07 +0000 Subject: [PATCH] Update readme with nix notes --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1b97b1aa..cd4aa97b 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,10 @@ Please have a look at the documentation under [`docs/`](docs/). To contribute to headscale you would need the lastest version of [Go](https://golang.org) and [Buf](https://buf.build)(Protobuf generator). +We recommend using [Nix](https://nixos.org/) to setup a development environment. This can +be done with `nix develop`, which will install the tools and give you a shell. +This guarantees that you will have the same dev env as `headscale` maintainers. + PRs and suggestions are welcome. ### Code style @@ -114,10 +118,12 @@ Check out the `.golangci.yaml` and `Makefile` to see the specific configuration. - Go - Buf -- Protobuf tools: +- Protobuf tools + +Install and activate: ```shell -make install-protobuf-plugins +nix develop ``` ### Testing and building @@ -139,6 +145,12 @@ make test To build the program: +```shell +nix build +``` + +or + ```shell make build ```