INSTALL: update for 1.3.0+, clarify IO::Compress

[public-inbox.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index f7e5999edcfdc4651ef8ea833fe09cf25533ff9a..4f0217a311b641818956ff28fd3f45180a948e15 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -21,9 +21,9 @@ Requirements
 public-inbox requires a number of other packages to access its full
 functionality.  The core tools are, of course:
 
-* Git (1.8.0+, 2.6+ for writing v2 repositories)
+* Git (1.8.0+, 2.6+ for writing v2 inboxes)
 * Perl 5.10.1+
-* DBD::SQLite (needed for NNTP, message threading, and v2 repositories)
+* DBD::SQLite (needed for NNTP, message threading, and v2 inboxes)
 
 To accept incoming mail into a public inbox, you'll likely want:
 
@@ -32,10 +32,6 @@ To accept incoming mail into a public inbox, you'll likely want:
 
 Beyond that, there is a long list of Perl modules required, starting with:
 
-* Date::Parse                      deb: libtimedate-perl
-                                   pkg: p5-TimeDate
-                                   rpm: perl-TimeDate
-
 * Digest::SHA                      typically installed with Perl
                                    rpm: perl-Digest-SHA
 
@@ -43,15 +39,23 @@ Beyond that, there is a long list of Perl modules required, starting with:
                                    pkg: p5-Email-MIME
                                    rpm: perl-Email-MIME
 
+* URI::Escape                      deb: liburi-perl
+                                   pkg: p5-URI
+                                   rpm: perl-URI
+                                   (for HTML/Atom generation)
+
+Plack and Date::Parse are optional as of public-inbox v1.3.0,
+but required for older releases:
+
 * Plack                            deb: libplack-perl
                                    pkg: p5-Plack
                                    rpm: perl-Plack, perl-Plack-Test,
                                    (for HTML/Atom generation)
 
-* URI::Escape                      deb: liburi-perl
-                                   pkg: p5-URI
-                                   rpm: perl-URI
-                                   (for HTML/Atom generation)
+- Date::Parse                      deb: libtimedate-perl
+                                   pkg: p5-TimeDate
+                                   rpm: perl-TimeDate
+                                   (for broken, mostly historical emails)
 
 Where "deb" indicates package names for Debian-derived distributions,
 "pkg" is for the FreeBSD package (maybe other common BSDs, too), and
@@ -130,14 +134,21 @@ above, so there is no need to explicitly install them:
                                     typically installed alongside Perl5)
 
 - Filesys::Notify::Simple          deb: libfilesys-notify-simple-perl
-                                   pkg: pkg-Filesys-Notify-Simple
+                                   pkg: p5-Filesys-Notify-Simple
                                    rpm: perl-Filesys-Notify-Simple
                                    (for public-inbox-watch, pulled in by Plack)
 
-- IO::Compress::Gzip               deb: perl-modules (or libio-compress-perl)
+- Linux::Inotify2                  deb: liblinux-inotify2-perl
+                                   rpm: perl-Linux-Inotify2
+                                   (for public-inbox-watch on Linux)
+
+- Filesys::Notify::KQueue          pkg: p5-Filesys-Notify-KQueue
+                                   (for public-inbox-watch on FreeBSD)
+
+- IO::Compress (::Gzip)            deb: perl-modules (or libio-compress-perl)
                                    pkg: perl5
                                    rpm: perl-IO-Compress
-                                   (for gzipped mbox over HTTP)
+                                   (for gzipped mbox over HTTP, v2 format)
 
 Uncommonly needed modules:
 
@@ -155,10 +166,6 @@ Uncommonly needed modules:
 
 Optional packages testing and development:
 
-- IPC::Run                         deb: libipc-run-perl
-                                   pkg: p5-IPC-Run
-                                   rpm: perl-IPC-Run
-
 - Plack::Test                      deb: libplack-test-perl
                                    pkg: p5-Plack
                                    rpm: perl-Plack-Test
@@ -167,9 +174,9 @@ Optional packages testing and development:
                                    pkg: perl5
                                    rpm: perl-Test-Simple
 
-- XML::Feed                        deb: libxml-feed-perl
-                                   pkg: p5-XML-Feed
-                                   rpm: perl-XML-Feed
+- XML::TreePP                      deb: libxml-treepp-perl
+                                   pkg: p5-XML-TreePP
+                                   rpm: perl-XML-TreePP
 
 standard MakeMaker installation (Perl)
 --------------------------------------
@@ -182,7 +189,7 @@ Once the dependencies are installed, you should be able to build and
 install the system (into /usr/local) with:
 
         perl Makefile.PL
-        make # GNU make is preferred, `gmake' on BSD systems
+        make
         make test
         make install # root permissions may be needed
 
@@ -203,5 +210,5 @@ the installation is complete.
 Copyright
 ---------
 
-Copyright 2013-2019 all contributors <meta@public-inbox.org>
+Copyright 2013-2020 all contributors <meta@public-inbox.org>
 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>