daemon2: check proper lockfile location in reap_children()

[tt-rss.git] / README

diff --git a/README b/README
index 2fa8791f3947cd10ef1609fcce2b93543675e609..1352f9c70185cff40df41cd277ba5b72995425d9 100644 (file)
--- a/README
+++ b/README
@@ -1,50 +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
 
-Version 1.1 adds experimental support for multi-user operation. This doesn't mean
-that TT-RSS is suitable for large-scale open internet installations. It still
-continues to be personal application, just in the looser definition, e.g. not just for
-you, but for your friends too, who won't DOS you or try to hack in each other accounts.
+Copyright (c) 2005-2010 Andrew Dolgov (unless explicitly stated otherwise).
 
+Requirements
+============
 
-Interface:
+       * 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
+==================
 
-       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;
+       http://tt-rss.org/wiki/InstallationNotes
 
-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)
+See also
+========
 
-         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).
+       * FAQ:                          http://tt-rss.org/wiki/FrequentlyAskedQuestions
+       * Forum:                                http://tt-rss.org/forum
+       * Wiki:                         http://tt-rss.org/wiki/WikiStart
 
-Don't forget to copy config.php-dist to config.php and edit it.
+Contact
+=======
 
-icons/ directory should be writable for your httpd user.
-
-Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>
+Send your questions, comments, patches to Andrew Dolgov <cthulhoo(at)gmail.com>