From: Ralph Ronnquist <ralph.ronnquist@gmail.com>
Date: Tue, 5 Jan 2021 22:51:11 +0000 (+1100)
Subject: merging from master
X-Git-Tag: 0.3.2~3
X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;ds=sidebyside;h=a77a1d322d74a02c08bb1be3ddfa062874225865;p=rrq%2Frrqnet.git

merging from master
---

diff --git a/readme.adoc b/readme.adoc
index 70a8e12..a56008c 100644
--- a/readme.adoc
+++ b/readme.adoc
@@ -1,18 +1,53 @@
 About rrqnet
 ============
 
-This repository holds the source for *rrqnet*, which offers VPN
+This repository holds the sources for *rrqnet*, which concern VPN
 building over UDP transport. *rrqnet* operates at Ethernet level and
-transports both ipv4 and ipv6. Thus, in addition to plain ipv4/6 VPN
-it may be used for tunneling ipv6 over ipv4 or ipv4 over ipv6.
+transports both ipv4 and ipv6. It can thus be used for all
+combinations of ipv4 and ipv6 tunneling over ipv4 or ipv6.
 
 MAN PAGES
 ---------
-  * link:rrqnet/src/branch/suites/experimental/rrqnet.8.adoc[The rrqnet man page]
-  * link:rrqnet/src/branch/suites/experimental/rrqnet-ifupdown.sh.8.adoc[The rrqnet-ifupdown.sh man page]
-  * link:rrqnet/src/branch/suites/experimental/rrqnet-cron.sh.8.adoc[The rrqnet-cron.sh man page]
+  * link:rrqnet.8.adoc[The rrqnet man page]
+  * link:rrqnet-cron.sh.8.adoc[The rrqnet-cron.sh man page]
+  * link:rrqnet-ifupdown.sh.8.adoc[The rrqnet-ifupdown.sh man page]
 
 Devuan Packages
 ---------------
 
-  * The *rrqnet* package contains the binary, scripts, and man pages.
+  * The *rrqnet* package contains the binaries and their man pages,
+as well as the utility scripting.
+
+Doing it by hand
+----------------
+
+
+Building
+~~~~~~~~
+
+.make
+[caption='Command {counter:Command}: ']
+====
+This command builds the static executable *rrqnet* and documentation
+as "man" pages and HTML formats (using asciidoc).
+====
+
+.make rrqnet
+[caption='Command {counter:Command}: ']
+====
+This command builds only the static executable *rrqnet*.
+====
+
+Installing
+~~~~~~~~~~
+
+The executable (*rrqnet*) should be installed as a system executable
+that in particular needs to be able to use network interfaces and
+(usually) create a tap.
+
+There are two helper scripts for adminstrating *rrqnet* virtual
+cabling:
+
+  * *rrqnet-cron.sh* for cron based persistence with bespoke configuration
+  * *rrqnet-ifupdown.sh* for adminstraion via *ifupdown*
+