commit: 118c21b80cea33858ffe769b9e816fb5c058f328
parent de7d4840497a52774e2f05ca5bac1804ff8062ab
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date: Sun, 16 Mar 2025 19:08:01 +0100
README: Add Building section
Diffstat:
1 file changed, 7 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -29,6 +29,13 @@ Developed on Linux+musl, automatically tested on FreeBSD, NetBSD and ArchLinux t
Set the `CC` and `CFLAGS` environment variables for your target, the usual `CROSS_COMPILE` is also supported as a fallback.
To compile the test binaries without running them, run `make build-checks`
+## Building
+0. (Optional, for when you don't already have utilities on the host): ``make -f bootstrap.mk && export PATH=$PWD/cmd:$PATH``
+1. ``sh ./configure``
+2. ``make``
+3. (optional, runs the tests) ``make check``
+4. (supports DESTDIR) ``make install``
+
## Licensing
The default license for new original works is the `MPL-2.0`, except when they should be broadly distributed and proprietary extensions aren't a concern (so `BSD-3-Clause`), or are considered under the copyright threshold (so `0BSD`).
