X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=README;h=de4057c387cbd07fbb0c5dfa0445842c744fd1ad;hb=01d9eb5b5d67e0d99a2fc8bd822343217552f042;hp=e9bd7d0af77079f54b44a93a5402c91eb80200cb;hpb=849dc69440ef9360acbf7ee0f5ac4996dc0a4d70;p=rss2email.git diff --git a/README b/README index e9bd7d0..de4057c 100644 --- a/README +++ b/README @@ -18,14 +18,15 @@ Installing rss2email Packages -------- -A quick way to get rss2email going is using pre-made packages. Here -are releases for Debian__ Linux, Ubuntu__ Linux, Gentoo__ Linux, -openSUSE__, and NetBSD__. +A quick way to get rss2email going is using pre-made packages. There +are releases for Debian__, Ubuntu__, Fedora__, openSUSE__, Gentoo__, +and NetBSD__. __ `Debian package`_ __ `Ubuntu package`_ -__ `Gentoo package`_ +__ `Fedora package`_ __ `openSUSE package`_ +__ `Gentoo package`_ __ `NetBSD package`_ Installing by hand @@ -40,15 +41,15 @@ things are in place. 1. Ensure that a version of Python_ ≥3.2 is installed. 2. Install the required Python packages. - 1. feedparser_ - 2. html2text_ + * feedparser_ + * html2text_ 3. Figure out how you are going to send outgoing email. You have two options here: either use an STMP server or a local sendmail program. So, - * determine your outgoing email server's SMTP address, or - * install sendmail (or a compatible replacement like postfix). + * determine your outgoing email server's SMTP address, or + * install sendmail (or a compatible replacement like postfix). Download ~~~~~~~~ @@ -58,12 +59,12 @@ from several equivalent formats. 1. A ``.zip`` file (suggested for Microsoft Windows users):: - $ wget https://github.com/wking/rss2email/archive/v3.2.zip + $ wget https://github.com/wking/rss2email/archive/v3.6.zip $ unzip rss2email-*.zip 2. A ``.tar.gz`` file (suggested for everyone else):: - $ wget https://github.com/wking/rss2email/archive/v3.2.tar.gz + $ wget https://github.com/wking/rss2email/archive/v3.6.tar.gz $ tar xvf rss2email*.tar.gz 3. A Git_ checkout (suggested for developers):: @@ -158,6 +159,9 @@ following to your configuration file:: You can make the email address whatever you want, but your mail server requires that the ``yoursite.com`` part actually exists. +You can also add custom filters, see the example and documentation in +``rss2email/post_process/prettify.py`` for more information. + SMTP ---- @@ -223,10 +227,12 @@ mailing list archives are available on Gmane_. http://packages.qa.debian.org/r/rss2email.html .. _Ubuntu package: https://launchpad.net/ubuntu/+source/rss2email +.. _Fedora package: + https://admin.fedoraproject.org/pkgdb/acls/name/rss2email .. _openSUSE package: https://build.opensuse.org/package/show?package=rss2email&project=server%3Amail .. _NetBSD package: - ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/pkgsrc/mail/rss2email/README.html + http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/mail/rss2email/README.html .. _Gentoo package: http://gpo.zugaina.org/net-mail/rss2email .. _Python: http://www.python.org