Tiny Tiny RSS
=============
-Server-side RSS feed aggregator written in PHP and heavily based
-on XmlHttpRequest and related technologies for user interface and
-operation.
+Web-based news feed aggregator, designed to allow you to read news from
+any location, while feeling as close to a real desktop application as possible.
-Licensed under GPL version 2.
+ http://tt-rss.spb.ru
-Warning: I don't know how to stress it enough - please do not install
-this program wide open to the whole internet. It belongs to (host or password)
-protected directory on your webserver. There could be SQL-injection or other
-remote vulnerabilities, so beware.
+Copyright (C) 2005 Andrew Dolgov unless stated otherwise.
-Also, TT-rss at present is not multi-user. It is designed for one person to
-read news consistently from different locations, one location at a time. Otherwise,
-last-read information will get messed up and other bad stuff could happen.
+Portions (C):
-Interface:
+ Bob Osola <bobosola@gmail.com> (pngfix.js)
+ Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js)
- There is (incomplete) support for keyboard navigation.
+Uses Prototype javascript library, from http://prototype.conio.net/
- "n" and "p" moves between next/previous posts when feed is opened, switching
- pages as needed.
+Licensed under GNU GPL version 2
- "r" refreshes feed list
+Features Overview
+=================
- "u" refreshes currently selected feed
+ Updates: http://tt-rss.spb.ru/trac/wiki/FeatureList
-Requirements:
+ * Server-side application, user only needs a web browser
+ * Supports RSS, RDF, Atom feeds using Magpie library
+ * Supports OPML import/export
+ * Easy setup and configuration
+ * Streamlined interface using XmlHttpRequest (or AJAX for laypeople)
+
+Requirements
+============
+
+ * Compatible browser on the client side
+
+ Basically, Firefox, Konqueror or MSIE6 are okay. See here
+ for more information:
+
+ http://tt-rss.spb.ru/trac/wiki/CompatibleBrowsers
+
+ * Web server, for example Apache
+ * PHP (requires PHP4 DOMXML extension)
+ * MagpieRSS feed parser (http://magpierss.sourceforge.net/)
+
+ * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required)
+
+ * XML-RPC for PHP library for XML-RPC support. Optional.
- - Magpie RSS (http://magpierss.sourceforge.net/) - place it into
- magpierss/ subdirectory;
- - PostgreSQL (example schema and configuration in ttrss_schema.sql)
+ http://phpxmlrpc.sourceforge.net
+
+Installation Notes
+==================
+
+ Updates: http://tt-rss.spb.ru/trac/wiki/InstallationNotes
+
+ * If you are upgrading from the previous version, don't forget to update
+ schema and logout.
+
+ * icons directory should be writable to your httpd user if you plan on
+ using feed icons
+
+ * Leave DB_HOST empty if you want to connect to database via unix socket
+
+ * For PostgreSQL don't forget to create database with UTF-8 encoding
+
+ createdb -E utf-8 -O owner_user database)
+
+ * Don't forget to change your password from default value on your first login
+
+ * Check your config.php for blank lines out of PHP code tags (e.g.
+ before <? and after ?>), See #1
+
+ * Default username:password for multiuser mode is admin:password.
+
+See also
+========
-Don't forget to copy config.php-dist to config.php and edit it.
+ * FAQ: http://tt-rss.spb.ru/trac/wiki/FrequentlyAskedQuestions
+ * Forum: http://tt-rss.spb.ru/forum
+ * Wiki: http://tt-rss.spb.ru/trac/wiki/WikiStart
+ * Bug Tracker: http://tt-rss.spb.ru/trac/report
-icons/ directory should be writable for your httpd user.
+Contact
+=======
Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>