Tiny Tiny RSS
=============
-! Please read UPGRADING for upgrade instructions from version 1.0.7 !
-
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.
+ http://tt-rss.spb.ru
+
Copyright (C) 2005 Andrew Dolgov unless stated otherwise.
Portions (C):
Bob Osola <bobosola@gmail.com> (pngfix.js)
Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js)
+ Sean M. Burke. <sburke@cpan.org> (xsl_mop-up.js)
-Licensed under GPL version 2.
+Other bundled libraries:
-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.
+ Prototype javascript library, from http://prototype.conio.net/
+ Script.aculo.us javascript library, http://http://script.aculo.us/
+ MagpieRSS feed parser, http://magpierss.sourceforge.net/
+ SimplePie feed parser, http://simplepie.org/
+ PHPMailer class, http://phpmailer.sourceforge.net/
-Version 1.1 adds support for multi-user operation, disable option SINGLE_USER_MODE
-to access it. Default user is "admin" with password "password", don't forget to
-change it.
+Licensed under GNU GPL version 2
-Interface:
+Features Overview
+=================
- There is (incomplete) support for keyboard navigation.
-
- "n" and "p" moves between next/previous posts when feed is opened;
- "r" refreshes feed list;
- "u" refreshes currently selected feed;
- "a" hides or shows only unread feeds in the feedlist;
- "j" move to previous feed
- "k" move to next feed
- "s" star/unstar selected article
-
-Requirements:
-
- - Magpie RSS (http://magpierss.sourceforge.net/) - place it into
- magpierss/ subdirectory;
-
- - RDBMS backend:
+ Updates: http://tt-rss.spb.ru/trac/wiki/FeatureList
+
+ * Server-side application, user only needs a web browser
+ * Supports RSS, RDF, Atom feeds using Magpie or SimplePie 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)
+ * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required)
+
+ * XML-RPC for PHP library for XML-RPC support. Optional.
- a) PostgreSQL
-
- b) MySQL (InnoDB and server version 4.1+ required)
+ 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.
- Example DB schemas and configuration are in schema/ subdirectory.
-
- For PostgreSQL don't forget to create database with UTF-8 encoding
- (createdb -E UTF-8 -O owner_user database).
+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>
git.wh0rd.org / tt-rss.git / blobdiff