diff options
Diffstat (limited to 'website/index.html')
| -rw-r--r-- | website/index.html | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/website/index.html b/website/index.html new file mode 100644 index 0000000..0d9c25f --- /dev/null +++ b/website/index.html @@ -0,0 +1,121 @@ +<?xml version="1.0" encoding="iso-8859-15"?> + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml"> + +<head> + <title>Feed2Imap</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/> + <meta name="keywords" content="feed,imap,rss,atom,email,mail,aggregator"/> + <meta name="description" content="Feed2Imap is an RSS/Atom aggregator that upload items to an IMAP server"/> + <link rel="stylesheet" type="text/css" href="feed2imap.css" /> + <link rel="alternate" type="application/rss+xml" title="RSS - New releases" href="feed2imap.rss" /> +</head> + +<body> + +<div class="menu"> +<a href="#rationale">Rationale</a> | +<a href="#screenshots">Screenshots</a> | +<a href="#download">Download</a> | +<a href="#installation">Installation</a> | +<a href="#bugreports">Bug reporting</a> | +<a href="#developer">Mailing List & Developers</a> | +<a href="http://gna.org/projects/feed2imap/">GNA project page</a> +</div> + +<div class="main"> + +<div class="titre"> +<h1>Feed2Imap</h1> +</div> + +<p>Feed2Imap is an RSS/Atom feed aggregator. After Downloading feeds (over +HTTP or HTTPS), it uploads them to a specified folder of an IMAP mail server. The user can then access the feeds using Mutt, Evolution, Mozilla Thunderbird or even a webmail.</p> + +<a name="rationale"></a> +<h2>Rationale</h2> + +<p>Feed2Imap is an attempt to solve the problem most roaming users experience +when trying to keep up with their feeds. Other solutions to this problem include :</p> +<ul> +<li>using classic aggregators like Straw, Liferea or Blam! and copy the database using scp (Yes, I know at least one person doing this.)</li> +<li>using <a href="http://www.bloglines.com">Bloglines</a>. It's slow, not flexible, and a commercial company.</li> +<li>using your own <a href="http://www.planetplanet.org/">Planet</a>. But it's not flexible at all, and not end-user friendly.</li> +<li>using a new application which hasn't been written yet : a client/server feed aggregator, so you could access your feed server remotely. The important part is "hasn't been written yet".</li> +</ul> + +<p>Feed2Imap isn't the first project transforming feeds into emails. <a href="http://exo.org.uk/code/rss2mail/">rss2mail</a> (Perl), <a href="http://www.aaronsw.com/2002/rss2email/">rss2email</a> (Python) and <a href="http://newspipe.sourceforge.net/">Newspipe</a> (Python) do this, but they send items as emails, so you spend a lot of time playing with procmail.</p> + +<a name="screenshots"></a> +<h2>Screenshots</h2> + +<p>Of course, it depends on your MUA !</p> +<p class="center"><img src="scr-evolution.jpg" alt="reading feeds with evolution"/><br/><i>Reading feeds with evolution</i></p> +<p class="center"><img src="scr-mutt.jpg" alt="reading feeds with mutt"/><br/><i>Reading feeds with mutt (yeah, some people do that!)</i></p> + +<a name="download"></a> +<h2>Download</h2> +<p>The lastest release is <a href="http://download.gna.org/feed2imap/feed2imap-0.9.2.tgz">version 0.9.2</a>.</p> +<p>Downloads are available on <a href="http://download.gna.org/feed2imap/">http://download.gna.org/feed2imap/</a>.</p> +<p>New releases are advertised using this <a href="http://home.gna.org/feed2imap/feed2imap.rss">RSS feed</a>.</p> +<p>There's also a Debian/Ubuntu package. If you are running Debian testing (etch), Debian unstable, Ubuntu Breezy or Ubuntu Dapper, just <b>apt-get install feed2imap</b>. +<!--If you aren't (Debian stable (sarge), ...), you must add <b>deb http://download.gna.org/feed2imap/debian ./</b> to your /etc/apt/sources.list first. +--> +</p> + +<a name="installation"></a> +<h2>Installation Instructions</h2> +<ul> +<li>Download it and untar it.</li> +<li>Run ./setup.rb as root, or figure out how to install it on your account by reading ./setup.rb --help (it's possible, but you have to take care of <i>RUBYPATH</i>.</li> +<li>Install the needed dependancies. For Debian, it is : ruby libtest-unit-ruby librexml-ruby librmail-ruby1.8 libyaml-ruby libopenssl-ruby libfeedparser-ruby rake (if you are using Debian Woody, find another solution : ruby is too old on woody). <a href="http://home.gna.org/ruby-feedparser/">Ruby-feedparser</a> can be downloaded <a href="http://download.gna.org/ruby-feedparser/">here</a>.</li> +<li>(Not mandatory, but a good idea :) run <i>rake test</i> and check that everything is working fine.</li> +<li>Copy feed2imaprc-example to ~/.feed2imaprc, edit it</li> +<li>Run feed2imap</li> +<li>If everything goes fine, add it to a crontab. Please don't make it run too often (every hour or so seems good). If you are using a recent version of cron, you can do clever things like this :<br/> +<i>*/30 0,7-23 * * * /usr/bin/feed2imap >/dev/null 2>&1</i></li> +</ul> + +<a name="bugreports"></a> +<h2>Bug Reporting</h2> + +<p>Bug reports should go to <a href="https://gna.org/bugs/?group=feed2imap">this bug tracker</a>. Please provide as much information as possible, including :</p> +<ul> +<li>A copy of the content of the feed you are trying to fetch. This means that you must save it using <i>wget</i> for example and attach it to the bug report.</li> +<li>The name and version of your IMAP server.</li> +<li>The versions of feed2imap and ruby-feedparser.</li> +<li>The usual stuff: is the problem reproduceable, etc.</li> +</ul> + +<a name="developer"></a> +<h2>Developers</h2> +<h3>Mailing List</h3> +<p><a href="mailto:feed2imap-develATgnaDOTorg">feed2imap-devel at gna dot org</a> is a mailing list for development and general discussion.</p> +<ul><li><a href="https://mail.gna.org/listinfo/feed2imap-devel/">Feed2Imap-devel Info Page</a> (to subscribe/unsubscribe, etc)</li> +<li><a href="https://mail.gna.org/public/feed2imap-devel/">Feed2Imap-devel archives</a></li> +</ul> + +<h3>(Sort of) Developer Documentation</h3> + +<p>Development takes place on the <a href="https://gna.org/projects/feed2imap/">GNA project page</a>. Don't hesitate to post feature requests, bugs or patches.</p> + +<p>Feed2Imap is written in <a href="http://www.ruby-lang.org">Ruby</a>. If you don't know this language yet, continue to ignore it. Learning it will make you realize what you missed until now, and you might run into severe problems (depression, etc).</p> + +<p>Source code is <a href="http://svn.gna.org/viewcvs/feed2imap/trunk/feed2imap/">browseable here</a>.</p> + +<p>You can get the source code from SVN using <i>svn co svn://svn.gna.org/svn/feed2imap/trunk/feed2imap</i>.</p> + +<p>The source code is quite easy to understand. Tasks are split into classes, themselves split into files :</p> +<ul> +<li>The main logic is in <i>feed2imap.rb</i>.</li> +<li>The config file is parsed in <i>config.rb</i> (but it's using <a href="http://www.yaml.org/">YAML</a>)</li> +<li>The cache management ("memory" of the items, so items don't get updated twice) is in <i>cache.rb</i>.</p> +<li>Fetching using HTTP is done in <i>httpfetcher.rb</i>.</li> +<li>Parsing is done using <a href="http://home.gna.org/ruby-feedparser/">Ruby-feedparser</a>.</li> +<li>Everything dealing with IMAP is in <i>imap.rb</i>.</li> +<li><i>rexml_patch.rb</i> and <i>rubymail_patch.rb</i> are small fixes (read: hacks) to REXML and Rubymail.</li> +</ul> +</body> +</html> |