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.spb.ru
   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
  16 Uses Prototype javascript library, from http://prototype.conio.net/
  17
  18 Licensed under GNU GPL version 2
  19
  20 Features Overview
  21 =================
  22
  23         Updates: http://tt-rss.spb.ru/trac/wiki/FeatureList
  24
  25         * Server-side application, user only needs a web browser
  26         * Supports RSS, RDF, Atom feeds using Magpie or SimplePie library
  27         * Supports OPML import/export
  28         * Easy setup and configuration
  29         * Streamlined interface using XmlHttpRequest (or AJAX for laypeople)
  30
  31 Requirements
  32 ============
  33
  34         * Compatible browser on the client side
  35
  36                 Basically, Firefox, Konqueror or MSIE6 are okay. See here
  37                 for more information:
  38
  39                 http://tt-rss.spb.ru/trac/wiki/CompatibleBrowsers
  40
  41         * Web server, for example Apache
  42         * PHP (requires PHP4 DOMXML extension)
  43         * MagpieRSS feed parser (http://magpierss.sourceforge.net/) OR
  44         * SimplePie feed parser (http://simplepie.org/)
  45
  46         * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required)
  47
  48         * XML-RPC for PHP library for XML-RPC support. Optional.
  49
  50                 http://phpxmlrpc.sourceforge.net
  51
  52 Installation Notes
  53 ==================
  54
  55         Updates: http://tt-rss.spb.ru/trac/wiki/InstallationNotes
  56
  57         * If you are upgrading from the previous version, don't forget to update
  58         schema and logout.
  59
  60         * icons directory should be writable to your httpd user if you plan on
  61         using feed icons
  62
  63         * Leave DB_HOST empty if you want to connect to database via unix socket
  64
  65         * For PostgreSQL don't forget to create database with UTF-8 encoding
  66
  67                         createdb -E utf-8 -O owner_user database)
  68
  69         * Don't forget to change your password from default value on your first login
  70
  71         * Check your config.php for blank lines out of PHP code tags (e.g.
  72         before <? and after ?>), See #1
  73
  74         * Default username:password for multiuser mode is admin:password.
  75
  76 See also
  77 ========
  78
  79         * FAQ:                          http://tt-rss.spb.ru/trac/wiki/FrequentlyAskedQuestions
  80         * Forum:                                http://tt-rss.spb.ru/forum
  81         * Wiki:                         http://tt-rss.spb.ru/trac/wiki/WikiStart
  82         * Bug Tracker:          http://tt-rss.spb.ru/trac/report
  83
  84 Contact
  85 =======
  86
  87 Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>