README: add warnings about the lack of v2 support
[ssoma.git] / INSTALL
blob6a03f376d7bec4765c2fee99a9c9f1939767c090
1 ssoma (client-side) installation
2 --------------------------------
3 This is for users who wish to follow archives hosted on public-inbox.
4 We only use commonly-available Perl modules available on Debian-based
5 distributions (and not necessarily modern ones!)
7 If you have problems or comments on installation, please send a
8 plain-text email to: meta@public-inbox.org
10 downloading
11 -----------
12 ssoma is available via git and tarballs.
13 The latest tarball release is available here:
15         http://ssoma.public-inbox.org/files/ssoma-0.2.0.tar.gz
17 You may also clone using git:
19         git clone git://80x24.org/ssoma
21 standard MakeMaker installation (Perl)
22 --------------------------------------
24         perl Makefile.PL
25         make
26         make test
27         make install # root permissions may be needed
29 Requirements
30 ------------
31 All packages should be easily available in Debian GNU/Linux and derived
32 distros.   Debian package names for Perl modules are are listed for
33 convenience.
35 * git (https://git-scm.com/)
36 * any MUA capable of reading/importing IMAP, mbox(5) or Maildir
37 * Perl and several modules:     (Debian package name (7.0))
38   - Digest::SHA                 perl
39   - Email::LocalDelivery        libemail-localdelivery-perl
40   - Email::MIME                 libemail-mime-perl
41   - File::Path::Expand          libfile-path-expand-perl
42   - IPC::Run                    libipc-run-perl
43   - Net::IMAP::Simple           libnet-imap-simple-perl
45 Copyright
46 ---------
47 Copyright 2013-2016 all contributors <meta@public-inbox.org>
48 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>