add preliminary INSTALL documentation

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..dd85d5e
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,36 @@
+Note: this still needs to be documented better,
+also see the scripts/ and sa_config/ directories in the source tree
+
+standard MakeMaker installation (Perl)
+--------------------------------------
+
+       perl Makefile.PL
+       make
+       make test
+       make install # root permissions may be needed
+
+Requirements (MUA client)
+-------------------------
+* git
+* ssoma - http://ssoma.public-inbox.org/README
+* Perl and several modules:
+    - Email::LocalDelivery
+    - Email::Filter
+    - Email::Simple
+    - Digest::SHA
+
+Requirements (server MDA)
+-------------------------
+* git
+* SpamAssassin (spamc/spamd)
+* MTA - postfix is recommended
+* ssoma - http://ssoma.public-inbox.org/README
+* Perl and several modules:
+    - Email::Simple
+    - File::FcntlLock
+    - Digest::SHA
+
+Copyright
+---------
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
+License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>

diff --git a/Makefile.PL b/Makefile.PL
index e7aea949688e71638cf50b11b68106ba5d3c5310..b2fbb18fda4e52d8de62e75213344be94dca810d 100644 (file)
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -21,7 +21,7 @@ WriteMakefile(
 sub MY::postamble {
   <<'EOF';
 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
-docs = README COPYING $(shell git ls-files Documentation/ '*.txt')
+docs = README COPYING INSTALL $(shell git ls-files Documentation/ '*.txt')
 gz_docs = $(addsuffix .gz, $(docs))
 %.gz: %
        gzip -9 --rsyncable < $< > $@+