]> pd.if.org Git - hexagon/blobdiff - README
added install target, README
[hexagon] / README
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..328553f
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+Compiling
+
+A simple make will compile the library, run the tests, and create the
+man page.  Running the tests is dependent on having a 'prove'
+command that will run a test harness.  This would normally
+be installed with perl.
+
+Installing
+
+make install will install the library to /usr/local.  If you
+want it somewhere else, you can pass PREFIX to make like so:
+
+make PREFIX=/usr install
+
+License
+
+This library is in the public domain.  All of the code was
+written by Nathan Wagner.