myriation/headscale
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity

Update readme with nix notes

Browse source
This commit is contained in:
Kristoffer Dalby 2022-03-07 16:58:07 +00:00
parent 5de9de14a9
commit 124d8a3424
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -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) To contribute to headscale you would need the lastest version of [Go](https://golang.org)
and [Buf](https://buf.build)(Protobuf generator). 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. PRs and suggestions are welcome.
### Code style ### Code style
@ -114,10 +118,12 @@ Check out the `.golangci.yaml` and `Makefile` to see the specific configuration.
- Go - Go
- Buf - Buf
- Protobuf tools: - Protobuf tools
Install and activate:
```shell ```shell
make install-protobuf-plugins nix develop
``` ```
### Testing and building ### Testing and building
@ -139,6 +145,12 @@ make test
To build the program: To build the program:
```shell
nix build
```
or
```shell ```shell
make build make build
``` ```