From 5f5e888a4f10f8052619ad850402f1fa4605a9ba Mon Sep 17 00:00:00 2001 From: Josh Deprez Date: Mon, 15 Apr 2024 11:38:30 +1000 Subject: [PATCH] Update README How to use --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ff80a9c..1c0f40d 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,21 @@ TashTalk could be a stretch goal, if I can acquire one! ## How to use -It's not ready yet. Come back later. \ No newline at end of file +WARNING: It Barely Works™ + +First, set up a `jrouter.yaml` (use the one in this repo as an example). + +TODO: explain the configuration file + +Building and running: + +```shell +go install gitea.drjosh.dev/josh/jrouter@latest +sudo setcap 'CAP_NET_BIND_SERVICE=ep CAP_NET_RAW=ep' ~/go/bin/jrouter +~/go/bin/jrouter +``` + +* `NET_BIND_SERVICE` is needed to bind UDP port 387 (for talking between AIRs) +* `NET_RAW` is needed for EtherTalk + +TODO: instructions for non-Linux machines