X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=README;h=1352f9c70185cff40df41cd277ba5b72995425d9;hb=e2eda97930a509673e2055c91308991dfd017ea4;hp=01bb0d26b180b277b6e4544ff30dabbadd062301;hpb=97aba8ec4e8898d9b9f2e792fe469051064a5500;p=tt-rss.git diff --git a/README b/README index 01bb0d26..1352f9c7 100644 --- a/README +++ b/README @@ -1,58 +1,36 @@ 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. -Copyright (C) 2005 Andrew Dolgov unless stated otherwise. - -Portions (C): - - Bob Osola (pngfix.js) - Sundar Dorai-Raj (isNumeric() in functions.js) - -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 -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. +Copyright (c) 2005-2010 Andrew Dolgov (unless explicitly stated otherwise). -Interface: +Requirements +============ - 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 + * 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 +================== -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) + http://tt-rss.org/wiki/InstallationNotes - 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.org/wiki/FrequentlyAskedQuestions + * Forum: http://tt-rss.org/forum + * Wiki: http://tt-rss.org/wiki/WikiStart -icons/ directory should be writable for your httpd user. +Contact +======= -Send your questions, comments, patches to Andrew Dolgov +Send your questions, comments, patches to Andrew Dolgov