lintian override for static binary

[rrq/rrqnet.git] / readme.adoc

diff --git a/readme.adoc b/readme.adoc
index 2721103864dc45e21fcd536d0532e42d72acc104..f216a2f164e80d7217ac09a8e15b47de831a3f6b 100644 (file)
--- a/readme.adoc
+++ b/readme.adoc
@@ -1,20 +1,53 @@
 About rrqnet
 ============
 
-This repository holds the sources for *rrqnet*, which concern VPN
-building over UDP transport. It operates at Ethernet level, which
-means it transports both ipv4 and ipv6, and it can thus be used for
-ipv6 over ipv4 tunneling, or ipv4 tunneling over ipv6, as well as ipv4
-VPN or ipv6 VPN.
+This repository holds the sources for *rrqnet*, which provides VPN
+building over UDP transport. *rrqnet* operates at Ethernet level and
+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/src/branch/suites/unstable/rrqnet.8.adoc[The rrqnet man page]
+  * link:rrqnet/src/branch/suites/unstable/rrqnet-ifupdown.sh.8.adoc[The rrqnet-ifupdown.sh man page]
+  * link:rrqnet/src/branch/suites/unstable/rrqnet-cron.8.adoc[The rrqnet-cron 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* for cron based persistence with bespoke configuration
+  * *rrqnet-ifupdown.sh* for adminstraion via *ifupdown*
+