summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAriadne Conill <ariadne@dereferenced.org>2022-05-03 17:38:03 +0000
committerTimo Teräs <timo.teras@iki.fi>2023-01-29 15:34:51 +0000
commitd6772adceccceaa1bee2254b6d29890e0aaaae08 (patch)
tree7d2ff0f554471e7284be5e4064cf92d657921ea5
parentc712919a796eeae6e1d85175b22edf3d362deb25 (diff)
downloadapk-tools-d6772adceccceaa1bee2254b6d29890e0aaaae08.tar.gz
apk-tools-d6772adceccceaa1bee2254b6d29890e0aaaae08.tar.bz2
apk-tools-d6772adceccceaa1bee2254b6d29890e0aaaae08.tar.xz
apk-tools-d6772adceccceaa1bee2254b6d29890e0aaaae08.zip
expand on the README file a little
-rw-r--r--README.md23
1 files changed, 21 insertions, 2 deletions
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.