X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=README;h=a040066a9323cf1bd1d4ec23466f1eec36073f2d;hb=9a91a51e0dcfd1a2e56c684531b75a566d76bfe6;hp=e2620e061d1ed91cecc6eb49d1b4645f3cb1bccd;hpb=62b6c0a8e7c1e9c8b6b6d505fa0d1640cc8b737f;p=tt-rss.git

diff --git a/README b/README
index e2620e06..a040066a 100644
--- a/README
+++ b/README
@@ -1,20 +1,91 @@
 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: This is alpha quality experimental code.
+Copyright (C) 2005 Andrew Dolgov unless stated otherwise.
 
-Requirements:
+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)
+
+Other bundled libraries:
+
+	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/
+
+Licensed under GNU GPL version 2
+
+Features Overview
+=================
+
+	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.
 	
-	- 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
+========
+
+	* 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
 
-Don't forget to copy config.php-dist to config.php and edit it.
+Contact
+=======
 
 Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>