From ae63944e40c2466e639f811ee8afc33d736185f4 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Wed, 19 Nov 2025 00:29:11 -0500 Subject: Add build instructions. --- BUILD.txt | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 BUILD.txt (limited to 'BUILD.txt') diff --git a/BUILD.txt b/BUILD.txt new file mode 100644 index 0000000..2c43e39 --- /dev/null +++ b/BUILD.txt @@ -0,0 +1,53 @@ +Build dependencies: + +- A Linux, BSD, or POSIX-like shell and environment. Mac OSX should + work, and so should Cygwin or MSYS on Windows. + +- A C compiler. The default is your system's "cc"; override the Makefile's + CC variable if you need to (see "Variables" section below). + +- Perl 5.x. Pretty much any version will do. + +- rst2man. Only needed for regenerating the man pages. + +Building: + +If you're experienced at building software from source, src/Makefile +should be self-explanatory. It requires GNU make, which might be +"gmake" on your system. + +If you're not experienced, you can start by extracting the source: + + tar xvf unalf-.tar.gz # replace with the actual version! + +Next, compile the software: + + gmake + +If you're on Slackware: + + sudo gmake install # or, as root, just 'gmake install' + +This will install the binaries, man pages, and docs in locations +appropriate for Slackware Linux (since that's what the author uses). + +If you're on a Debian or Ubuntu derivative, use: + + sudo gmake install MANDIR=/usr/share/man DOCDIR=/usr/share/doc/unalf + +If you're on some other OS (Red Hat, *BSD, OSX, etc), ask someone +who actually uses that OS if you're not sure where things should be +installed to. + +If you prefer /usr/local: + + sudo gmake install PREFIX=/usr/local MANDIR=/usr/local/share/man DOCDIR=/usr/local/share/doc/unalf + +Variables: + +You can set variables on the gmake command line. Example: + + gmake CC=clang COPT=-Os # use a different compiler, optimize for size + +See the top of src/Makefile for details on what variables exist and what +they're used for (not going to duplicate the list here). -- cgit v1.2.3