From 985e7fd50efdb76c17c815f2f62c265ed41dfb07 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sun, 20 Apr 2014 19:46:11 +0000 Subject: [PATCH] some minor documentation tweaks Hopefully clarify things for folks coming from public-inbox. --- INSTALL | 7 ++++++- README | 18 ++++++++++++++---- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/INSTALL b/INSTALL index 8f0e378..e220029 100644 --- a/INSTALL +++ b/INSTALL @@ -1,3 +1,9 @@ +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!) + standard MakeMaker installation (Perl) -------------------------------------- @@ -8,7 +14,6 @@ standard MakeMaker installation (Perl) 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. diff --git a/README b/README index 7efe951..8b00f60 100644 --- a/README +++ b/README @@ -1,11 +1,13 @@ ssoma - some sort of mail archiver ---------------------------------- - ssoma is a git-based mail archiver and transport. Email is injected via ssoma-mda(1) (MDA: mail delivery agent) on a server and may be shared -(via git) and extracted to mbox, Maildir, or IMAP via ssoma(1). It -exists primarily as the mechanism for public-inbox but may easily be -used for other projects. +(via git) and extracted to mbox, Maildir, or IMAP via ssoma(1). ssoma +exists primarily as the mechanism (not policy) for public-inbox but may +easily be used for other projects. + +Readers of public-inbox instances may install ssoma to extract messages +into their favorite mail client for reading. See http://public-inbox.org/ for more information on how ssoma is used. @@ -15,6 +17,11 @@ Features * mail user-agent (MUA) users may choose from IMAP, mbox(5), and Maildir * uses only well-documented and easy-to-implement data formats +Install +------- +Installation should be easy and require only a few, commonly-available +packages. See http://ssoma.public-inbox.org/INSTALL.html for details. + Hacking ------- Source code is available via git: @@ -59,6 +66,9 @@ You can subscribe via ssoma, LISTNAME is a name of your choosing: # to sync all your ssoma subscriptions ssoma sync + # You may wish to sync in your cronjob + ssoma sync --cron + Mail repository format ---------------------- If you are uncomfortable running code in ssoma for any reason and -- 2.26.2