Add INSTALL.

1 files changed, 28 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..0df9c3e
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,28 @@
+Requirements:
+
+- OS: Unix/POSIX-ish system. Linux, for example.
+- Compiler: Recent(ish) gcc or clang (others may work: tcc seems to,
+  pcc seems not to).
+- X11 and Xpm libraries and headers.
+- GNU Make, any recent version. Probably even ancient versions.
+- A Bourne-like shell (for make to use).
+- gzip, install, mkdir commands.
+
+Only needed if you're going to rebuild the man page (after
+modifying the RST):
+
+- rst2man, possibly in your 'python-docutils' distro package.
+
+A full install of Slackware should have all you need. On Debian
+or Ubuntu, try "apt-get install build-essentials".
+
+To build, just run "make", optionally followed by "make install".
+
+Packagers: the Makefile supports the full panoply of tweakable
+parameters, such as CC, CFLAGS, LDFLAGS, DESTDIR, PREFIX, etc. Have
+a look at the top of the Makefile for the full list. The defaults
+should be reasonable, except you probably want some optimization
+in CFLAGS. If you package this for your distro, send me an email
+(urchlay@slackware.uk), let me know if you ran into any problems. A
+hint: don't bother to include this INSTALL file in your binary package
+(users won't find it useful).