README

   1 Tiny Tiny RSS
   2 =============
   3
   4 Web-based news feed aggregator, designed to allow you to read news from
   5 any location, while feeling as close to a real desktop application as possible.
   6
   7         http://tt-rss.org
   8
   9 Copyright (C) 2005 Andrew Dolgov unless stated otherwise.
  10
  11 Portions (C):
  12
  13         Bob Osola <bobosola@gmail.com> (pngfix.js)
  14         Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js)
  15         Sean M. Burke. <sburke@cpan.org> (xsl_mop-up.js)
  16
  17 Other bundled libraries:
  18
  19         Prototype javascript library, from http://prototype.conio.net/
  20         Script.aculo.us javascript library, http://http://script.aculo.us/
  21         MagpieRSS feed parser, http://magpierss.sourceforge.net/
  22         SimplePie feed parser, http://simplepie.org/
  23         PHPMailer class, http://phpmailer.sourceforge.net/
  24
  25 Licensed under GNU GPL version 2
  26
  27 Features Overview
  28 =================
  29
  30         Updates: http://tt-rss.org/trac/wiki/FeatureList
  31
  32         * Server-side application, user only needs a web browser
  33         * Supports RSS, RDF, Atom feeds using Magpie or SimplePie library
  34         * Supports OPML import/export
  35         * Easy setup and configuration
  36         * Streamlined interface using XmlHttpRequest (or AJAX for laypeople)
  37
  38 Requirements
  39 ============
  40
  41         * Compatible browser on the client side
  42
  43                 Basically, Firefox, Konqueror or MSIE6 are okay. See here
  44                 for more information:
  45
  46                 http://tt-rss.org/trac/wiki/CompatibleBrowsers
  47
  48         * Web server, for example Apache
  49         * PHP (requires PHP4 DOMXML extension)
  50         * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required)
  51
  52         * XML-RPC for PHP library for XML-RPC support. Optional.
  53
  54                 http://phpxmlrpc.sourceforge.net
  55
  56 Installation Notes
  57 ==================
  58
  59         Updates: http://tt-rss.org/trac/wiki/InstallationNotes
  60
  61         * If you are upgrading from the previous version, don't forget to update
  62         schema and logout.
  63
  64         * icons directory should be writable to your httpd user if you plan on
  65         using feed icons
  66
  67         * Leave DB_HOST empty if you want to connect to database via unix socket
  68
  69         * For PostgreSQL don't forget to create database with UTF-8 encoding
  70
  71                         createdb -E utf-8 -O owner_user database)
  72
  73         * Don't forget to change your password from default value on your first login
  74
  75         * Check your config.php for blank lines out of PHP code tags (e.g.
  76         before <? and after ?>), See #1
  77
  78         * Default username:password for multiuser mode is admin:password.
  79
  80 See also
  81 ========
  82
  83         * FAQ:                          http://tt-rss.org/trac/wiki/FrequentlyAskedQuestions
  84         * Forum:                                http://tt-rss.org/forum
  85         * Wiki:                         http://tt-rss.org/trac/wiki/WikiStart
  86         * Bug Tracker:          http://tt-rss.org/trac/report
  87
  88 Contact
  89 =======
  90
  91 Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>