From 329736d51862b767cdaecf5c13a53e642164fbae Mon Sep 17 00:00:00 2001
From: Eric Wong <e@80x24.org>
Date: Thu, 9 Jan 2014 22:46:39 +0000
Subject: add preliminary INSTALL documentation

---
 INSTALL     | 36 ++++++++++++++++++++++++++++++++++++
 Makefile.PL |  2 +-
 2 files changed, 37 insertions(+), 1 deletion(-)
 create mode 100644 INSTALL

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 00000000..dd85d5e0
--- /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 e7aea949..b2fbb18f 100644
--- 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 < $< > $@+
-- 
cgit v1.2.3-24-ge0c7