summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--HACKING42
1 files changed, 42 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..f626e5a
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,42 @@
+Hacking the ProteanOS Archive Manager
+=====================================
+
+Version Control
+---------------
+
+pro-archman is maintained in a Git repository:
+
+ http://git.proteanos.com/pro-archman/pro-archman.git/
+
+The repository can be cloned from the following URI:
+
+ git://git.proteanos.com/pro-archman/pro-archman.git
+
+Running Without Installing
+--------------------------
+
+pro-archman can be run without being installed on the system. After configuring
+and building, run pro-archman as follows from the top-level source directory:
+
+ $ ARCHMAN_LIBDIR=lib ARCHMAN_LOCALEDIR=locale src/pro-archman
+
+`ARCHMAN_LIBDIR` and `ARCHMAN_LOCALEDIR` override the configured `libdir` and
+`localedir`, respectively.
+
+Mailing List
+------------
+
+Bug reports, feature requests, and patches for pro-archman are welcome on the
+ProteanOS development mailing list:
+
+ http://lists.proteanos.com/proteanos-dev/
+
+Copyright Information
+---------------------
+
+Copyright (C) 2013 Patrick "P. J." McDermott
+
+Copying and distribution of this file, with or without modification,
+are permitted in any medium without royalty provided the copyright
+notice and this notice are preserved. This file is offered as-is,
+without any warranty.