summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-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: