From 68f5c24bd7240feb5ad21b82fcdd09917eefeeb3 Mon Sep 17 00:00:00 2001
From: Ralph Ronnquist <ralph.ronnquist@gmail.com>
Date: Wed, 6 Jan 2021 09:30:51 +1100
Subject: [PATCH] slight update
---
readme.adoc | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/readme.adoc b/readme.adoc
index bd2951b..a56008c 100644
--- a/readme.adoc
+++ b/readme.adoc
@@ -10,9 +10,44 @@ MAN PAGES
---------
* 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 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*
+
--
2.39.5