summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKiyoshi Aman <kiyoshi.aman+adelie@gmail.com>2019-07-07 11:20:15 -0500
committerKiyoshi Aman <kiyoshi.aman+adelie@gmail.com>2019-07-07 11:20:15 -0500
commit426c5d305e2cb2c17b65c7369d42c157adc9d8e6 (patch)
treebba63ae28b4361117cb2f69ae5b828d7c34b5121
parent1c187f30766877f24a27bacc0329e809274ac41c (diff)
downloaduserland-426c5d305e2cb2c17b65c7369d42c157adc9d8e6.tar.gz
userland-426c5d305e2cb2c17b65c7369d42c157adc9d8e6.tar.bz2
userland-426c5d305e2cb2c17b65c7369d42c157adc9d8e6.tar.xz
userland-426c5d305e2cb2c17b65c7369d42c157adc9d8e6.zip
README.md: document buildsystem
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index ec406f1..6a2d090 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Userland
-This project is a port of NetBSD userland (`bin`, `sbin`, `usr.bin`, and `usr.sbin` in the NetBSD `src` distribution) to the musl implementation of the C standard library. It aims to provide a complete POSIX userland, with support for user-friendly extensions.
+This project is a port of NetBSD userland utilities to the musl implementation of the C standard library. It aims to provide a complete POSIX userland, with support for user-friendly extensions regardless of origin.
# Rationale
@@ -10,6 +10,18 @@ There are a multitude of other projects which aim to provide a Linux userland. N
All code in this repository is licensed under `BSD-3-Clause`; see `LICENSE` for a copy of the license text.
+# Building
+
+To build `userland`, you will need:
+
+* gprbuild
+* libbsd and development headers
+* `fts` support library for musl
+* `utmps` (required for `who(1)`), and therefore `skalibs`
+* byacc
+
+`make` and `make install` will do as you expect. It is *strongly* recommended that you provide `DESTDIR` so as to avoid clobbering existing userland utilities.
+
# Contributing
Contributions may be made in several ways: