From 390fb81cdf9a622fab5f1757b249ddf0b2796d88 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Tue, 24 Dec 2024 04:33:24 -0500 Subject: add install notes to README --- README | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README b/README index 755501e..6e57e6d 100644 --- a/README +++ b/README @@ -4,4 +4,17 @@ uxd is a hex dump utility that's aware of UTF-8 multibyte sequence semantics, and uses colorized output to indicate which byte sequences go with which human-readable characters. +uxd should compile and run on any modern POSIX-ish system. It's +developed on Linux, and has been tested on Mac OS X. It's written in +ANSI/ISO C89 and uses no libraries other than the standard C library. +The Makefile should be compatible with any make utility (does not use +GNU or BSD specific constructs). + +To install, use "make install" as root. This will put the binary +in /usr/bin and the gzipped man page in /usr/man/man1. To adjust +the install paths, use the standard make variables PREFIX, DESTDIR, +BINDIR, DESTDIR, etc. See the top of the Makefile for the full list. +Installation isn't required: the binary doesn't depend on any other +files at runtime, and can just be copied somewhere on your $PATH. + See uxd.rst for full documentation, or (after installation), "man uxd". -- cgit v1.2.3