From d6772adceccceaa1bee2254b6d29890e0aaaae08 Mon Sep 17 00:00:00 2001
From: Ariadne Conill <ariadne@dereferenced.org>
Date: Tue, 3 May 2022 17:38:03 +0000
Subject: expand on the README file a little

---
 README.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index be82d4e..fdbaae4 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,24 @@
-# Alpine Package Keeper
+# apk-tools
 
-Alpine Package Keeper (apk) is a package manager developed for Alpine Linux.
+Alpine Package Keeper (apk) is a package manager originally built for Alpine Linux,
+but now used by several other distributions as well.
+
+## Building
+
+The preferred build system for building apk-tools is Meson:
+
+```
+# meson setup build --prefix=/
+# meson compile -C build
+# meson install -C build
+```
+
+While there is a legacy Makefile-based system available, it only works for musl-linux
+targets, and will be dropped in the apk-tools 3.0 release.
+
+## Documentation
 
 Online documentation is available in the [doc/](doc/) directory in the form of man pages.
+
+The [apk(8)](doc/apk.8.scd) man page provides a basic overview of the package management
+system.
-- 
cgit v1.2.3-70-g09d2