diff --git a/README.md b/README.md index 3a8b63d86..691663f5f 100644 --- a/README.md +++ b/README.md @@ -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._
+**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.*
-**_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 ./... ```