~kt/udprelay

2491c5fe2614f6dce97d7e89d12f26c733ab91c5 — Katie Wolfe 4 months ago c861f84
Add Installation section to README.md
1 files changed, 8 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +8 -0
@@ 4,6 4,14 @@

For documentation on the program and protocol, check **udprelay**(1) and **udprelay**(7) respectively.

# Building & Installation

A udprelay package for Arch Linux is available in the AUR ([udprelay](https://aur.archlinux.org/packages/udprelay)). If you maintain a udprelay package for your distro, feel free to submit a patch to add a link to this README!

Building udprelay from source only requires an installation of Go and its standard library. Run `make udprelay` to build the udprelay binary.

To make the man pages, you will need to have [scdoc](https://git.sr.ht/~sircmpwn/scdoc/). Simply run `make docs` to generate `udprelay.1` and `udprelay.7`.

# Contributing

Feel free to submit patches or ask questions at [~kt/udprelay@lists.sr.ht](mailto:~kt/udprelay@lists.sr.ht)