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