Skip to content

Commit

Permalink
Update contribution guide with go version and Windows driver (netbird…
Browse files Browse the repository at this point in the history
  • Loading branch information
mlsmaycon authored Oct 17, 2023
1 parent 5757c46 commit 8b8e7ba
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ If you haven't already, join our slack workspace [here](https://join.slack.com/t
- [Test suite](#test-suite)
- [Checklist before submitting a PR](#checklist-before-submitting-a-pr)
- [Other project repositories](#other-project-repositories)
- [Checklist before submitting a new node](#checklist-before-submitting-a-new-node)
- [Contributor License Agreement](#contributor-license-agreement)

## Code of conduct
Expand Down Expand Up @@ -70,7 +69,7 @@ dependencies are installed. Here is a short guide on how that can be done.

### Requirements

#### Go 1.19
#### Go 1.21

Follow the installation guide from https://go.dev/

Expand Down Expand Up @@ -139,15 +138,14 @@ checked out and set up:
### Build and start
#### Client

> Windows clients have a Wireguard driver requirement. We provide a bash script that can be executed in WLS 2 with docker support [wireguard_nt.sh](/client/wireguard_nt.sh).
To start NetBird, execute:
```
cd client
# bash wireguard_nt.sh # if windows
go build .
```

> Windows clients have a Wireguard driver requirement. You can downlowd the wintun driver from https://www.wintun.net/builds/wintun-0.14.1.zip, after decompressing, you can copy the file `windtun\bin\ARCH\wintun.dll` to the same path as your binary file or to `C:\Windows\System32\wintun.dll`.
To start NetBird the client in the foreground:

```
Expand Down

0 comments on commit 8b8e7ba

Please sign in to comment.