extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2024-12-04 22:10:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix(README.md) Codacy style

Browse Source
This commit is contained in:
shatoboar 2022-06-28 13:58:51 +02:00
parent 2ddf24c7eb
commit 57472fb84f
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -105,31 +105,30 @@ We use open-source technologies like [WireGuard®](https://www.wireguard.com/),
### Legal
[WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.
### Contribution
**You have a working Go environment**
Clone the project into your preferred path. We recommend just cloning into the GOPATH.
```
```bash
mkdir -p $GOPATH/src/github.com/netbirdio
cd $GOPATH/src/github.com/netbirdio
git clone git@github.com:netbirdio/netbird.git
cd netbird
go build ./...
```
**_Sidenote_**
_`libayatana-appindicator3-dev` might be needed for developing
the client-ui [ui](https://github.com/netbirdio/netbird/tree/main/client/ui) on debian based distros._<br>
**Sidenote**
*`libayatana-appindicator3-dev` might be needed for developing
the client-ui [ui](https://github.com/netbirdio/netbird/tree/main/client/ui) on debian based distros.*<br>
**_Sidenote_**
_The command won't produce a binary, but only check for working builds.
If you want to produce a binary, you need to `cd` into the specific subproject and use `go build`._
**Sidenote**
*The command won't produce a binary, but only check for working builds.
If you want to produce a binary, you need to `cd` into the specific subproject and use `go build`.*
**To run the tests run**
```
```bash
go test -exec sudo ./...
```