mirror of
https://github.com/netbirdio/netbird.git
synced 2026-04-19 08:46:38 +00:00
Compare commits
7 Commits
separate_p
...
documentat
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
57472fb84f | ||
|
|
2ddf24c7eb | ||
|
|
841fa44072 | ||
|
|
2c2790603e | ||
|
|
f31f8a76fb | ||
|
|
b052e74fe7 | ||
|
|
89f9c498f1 |
30
README.md
30
README.md
@@ -105,3 +105,33 @@ We use open-source technologies like [WireGuard®](https://www.wireguard.com/),
|
|||||||
### Legal
|
### Legal
|
||||||
[WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.
|
[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**
|
||||||
|
*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 ./...
|
||||||
|
```
|
||||||
|
|
||||||
|
The tests need to be executed with sudo permissions, as our integration tests need to create network interfaces.
|
||||||
|
|
||||||
|
For further information about contributing to the Netbird project, please refer to our [documentation](https://netbird.io/docs/development/contributing).
|
||||||
|
|||||||
@@ -1,2 +1,6 @@
|
|||||||
### Architecture
|
### Architecture
|
||||||
TODO
|
|
||||||
|
**Our docs have moved to a separate [repository](https://netbird.io/docs).** <br>
|
||||||
|
|
||||||
|
To get more insight into netbird's architecture refer to this [documentation](https://netbird.io/docs/overview/architecture).
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user