Add INSTALL.

1 files changed, 15 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..98c50cd
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,15 @@
+Prerequisites should be available on any *nix-like system. You need
+make (GNU or BSD; others may work), a C compiler (gcc, clang, and
+even pcc will work). If you're going to modify the man page, you'll
+need rst2man. If you're going to "make install", you need a GNU-style
+install command, a mkdir command that accepts -p, and gzip.
+
+A simple "make && sudo make install" should work, if you're not
+creating a package. Binary will go to /usr/local/bin, man page in
+/usr/local/share/man1, README in /usr/local/share/doc/xdeadzone.
+
+If you're a packager, have a look at the top of the Makefile for
+variables you can override. Paths don't get "baked in" to the binary,
+so you only have to override them on the "make install". Don't include
+this INSTALL file in your package; it's useless for binary package
+users.