ssoma-mda: Use the email subject as the commit message
[ssoma-mda.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index d55d77320b042c88349f3fc8c6023b9bae0f9611..691b122d50b9110d92e0b74e702735aba258291a 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,3 +1,23 @@
+ssoma (client-side) installation
+--------------------------------
+This is for users who wish to follow archives hosted on public-inbox.
+We only use commonly-available Perl modules available on Debian-based
+distributions (and not necessarily modern ones!)
+
+If you have problems or comments on installation, please send a
+plain-text email to: meta@public-inbox.org
+
+downloading
+-----------
+ssoma is available via git and tarballs.
+The latest tarball release is available here:
+
+       http://ssoma.public-inbox.org/files/ssoma-0.1.0.tar.gz
+
+You may also clone using git:
+
+       git clone git://80x24.org/ssoma
+
 standard MakeMaker installation (Perl)
 --------------------------------------
 
@@ -6,24 +26,20 @@ standard MakeMaker installation (Perl)
        make test
        make install # root permissions may be needed
 
-Requirements (MUA client)
--------------------------
-* git
-* Perl and several modules:
-    - Email::LocalDelivery
-    - Email::Simple
-    - Net::IMAP::Simple
-    - Digest::SHA
-* any MUA capable of reading/importing IMAP, mbox(5) or Maildir
+Requirements
+------------
+All packages should be easily available in Debian GNU/Linux and derived
+distros.   Debian package names for Perl modules are are listed for
+convenience.
 
-Requirements (server MDA)
--------------------------
-* git
-* MTA - postfix is recommended
-* Perl and several modules:
-    - Email::Simple
-    - File::FcntlLock
-    - Digest::SHA
+* git (https://git-scm.com/)
+* any MUA capable of reading/importing IMAP, mbox(5) or Maildir
+* Perl and several modules:     (Debian package name (7.0))
+  - Digest::SHA                 perl
+  - Email::LocalDelivery        libemail-localdelivery-perl
+  - Email::Simple               libemail-simple-perl
+  - File::Path::Expand          libfile-path-expand-perl
+  - Net::IMAP::Simple           libnet-imap-simple-perl
 
 Copyright
 ---------