From 6d1c67ed380d0afb6f3e126307a548a878bff15f Mon Sep 17 00:00:00 2001
From: Ariadne Conill <ariadne@dereferenced.org>
Date: Fri, 24 Jul 2020 07:17:18 -0600
Subject: [PATCH] README: note how to build apps, docs and run the tests

---
 README.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 713e281..7bc19dc 100644
--- a/README.md
+++ b/README.md
@@ -24,5 +24,11 @@ For compatibility with some legacy ifupdown executors, we also provide the
 * ifupdown-ng retains compatibility with /etc/network/if-X.d scripts, but will
   prefer using executors in /usr/libexec/ifupdown-ng where appropriate.
 
-This package is planned to replace BusyBox ifupdown in Alpine at some point in
-the future.
+## Building
+
+Simply do `make` and `make install` to build and install.
+
+To run the tests, do `make check`.
+
+To build the documentation, do `make docs` and `make install_docs`.  Building
+the documentation requires scdoc (`apk add scdoc`).