Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.51 KB

Contributing to mbdns

We welcome contributions to mbdns of any kind, including documentation, functional patches, bug reports, issues, feature requests, feature implementations, pull requests, etc.

Building mbdns

Run build-test to build a single binary from your git checkout. go build will place it into ../bin/mbdns.

Run build-rel RELEASE_NAME if you'd like to build all supports binaries for a release. The release script will put the current git revision for HEAD into BuildVersion if you don't supply RELEASE_NAME. go build will place binaries into bin/RELEASE_NAME.

Current supported platform configs

While there's no golang code in mbdns that isn't portable to any platform that golang supports, the release build script only builds for platforms we've tested and are known to work.

Those configs are:

GOOS GOARCH Hardware and OS platform(s)
linux arm QNAPs
linux mipsle Ubiquiti EdgeRouters
darwin amd64 macOS 10.13+
freebsd amd64 FreeNAS, TrueNAS and FreeBSD proper
linux amd64 Various Linuxes
linux arm64 Ubiquiti UDM-SE and UDR

Golang requirements

mbdns has no special golang requirements. Releases are currently generated by go version go1.81.1 darwin/amd64.

Licensing

mbdns is MIT licensed.