X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=README;h=1352f9c70185cff40df41cd277ba5b72995425d9;hb=9c99281f20f938701f8645aad1d25412ca6538a7;hp=e1ef72490e9f2426eaee4848260cf271de4eb5a6;hpb=1aab5aec906716c4e2af8f7a956d447f1643a153;p=tt-rss.git diff --git a/README b/README index e1ef7249..1352f9c7 100644 --- a/README +++ b/README @@ -1,51 +1,36 @@ 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.org -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. +Licensed under GNU GPL version 2 -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. +Copyright (c) 2005-2010 Andrew Dolgov (unless explicitly stated otherwise). -Interface: +Requirements +============ - There is (incomplete) support for keyboard navigation. + * Compatible web browser (http://tt-rss.org/wiki/CompatibleBrowsers) + * Web server, for example Apache + * PHP (with support for mbstring functions) + * PostgreSQL (tested on 8.3) or MySQL (InnoDB and version 4.1+ required) + +Installation Notes +================== - "n" and "p" moves between next/previous posts when feed is opened, switching - pages as needed. + http://tt-rss.org/wiki/InstallationNotes - "r" refreshes feed list +See also +======== - "u" refreshes currently selected feed + * FAQ: http://tt-rss.org/wiki/FrequentlyAskedQuestions + * Forum: http://tt-rss.org/forum + * Wiki: http://tt-rss.org/wiki/WikiStart -Requirements: - - - Magpie RSS (http://magpierss.sourceforge.net/) - place it into - magpierss/ subdirectory; - - - RDBMS backend: - - a) PostgreSQL - - b) MySQL (InnoDB and server version 4.1+ required) +Contact +======= - example DB schemas and configuration in ttrss_schema.sql and - ttrss_schema_mysql.sql. - - For PostgreSQL don't forget to create database with UTF-8 encoding - (createdb -E UTF-8 -O owner_user database). - -Don't forget to copy config.php-dist to config.php and edit it. - -icons/ directory should be writable for your httpd user. - -Send your questions, comments, patches to Andrew Dolgov +Send your questions, comments, patches to Andrew Dolgov