]> git.wh0rd.org - tt-rss.git/blame - README
add prototype three columns theme
[tt-rss.git] / README
CommitLineData
1945c416
AD
1Tiny Tiny RSS
2=============
3
fbd94c53
AD
4Web-based news feed aggregator, designed to allow you to read news from
5any location, while feeling as close to a real desktop application as possible.
1945c416 6
8983d995 7 http://tt-rss.spb.ru
09165533 8
fbd94c53
AD
9Copyright (C) 2005 Andrew Dolgov unless stated otherwise.
10
b2e9654e 11Portions (C):
fbd94c53
AD
12
13 Bob Osola <bobosola@gmail.com> (pngfix.js)
14 Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js)
b2e9654e 15
5a4ef316
AD
16Uses Prototype javascript library, from http://prototype.conio.net/
17
8983d995
AD
18Licensed under GNU GPL version 2
19
20Features Overview
21=================
22
23 Updates: http://tt-rss.spb.ru/trac/wiki/FeatureList
24
25 * Server-side application, user only needs a web browser
26 * Supports RSS, RDF, Atom feeds using Magpie library
27 * Supports OPML import/export
28 * Easy setup and configuration
29 * Streamlined interface using XmlHttpRequest (or AJAX for laypeople)
30
31Requirements
32============
33
34 * Compatible browser on the client side
35
36 Basically, Firefox, Konqueror or MSIE6 are okay. See here
37 for more information:
38
39 http://tt-rss.spb.ru/trac/wiki/CompatibleBrowsers
40
41 * Web server, for example Apache
42 * PHP (requires PHP4 DOMXML extension)
43 * MagpieRSS feed parser (http://magpierss.sourceforge.net/)
44
45 * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required)
46
1205abd0
AD
47 * XML-RPC for PHP library for XML-RPC support. Optional.
48
49 http://phpxmlrpc.sourceforge.net
50
8983d995
AD
51Installation Notes
52==================
53
54 Updates: http://tt-rss.spb.ru/trac/wiki/InstallationNotes
55
56 * If you are upgrading from the previous version, don't forget to update
57 schema and logout.
58
59 * icons directory should be writable to your httpd user if you plan on
60 using feed icons
61
62 * Leave DB_HOST empty if you want to connect to database via unix socket
63
64 * For PostgreSQL don't forget to create database with UTF-8 encoding
65
66 createdb -E utf-8 -O owner_user database)
67
68 * Don't forget to change your password from default value on your first login
69
70 * Check your config.php for blank lines out of PHP code tags (e.g.
71 before <? and after ?>), See #1
72
c017149c
AD
73 * Default username:password for multiuser mode is admin:password.
74
8983d995
AD
75See also
76========
77
78 * FAQ: http://tt-rss.spb.ru/trac/wiki/FrequentlyAskedQuestions
79 * Forum: http://tt-rss.spb.ru/forum
80 * Wiki: http://tt-rss.spb.ru/trac/wiki/WikiStart
81 * Bug Tracker: http://tt-rss.spb.ru/trac/report
82
83Contact
84=======
78800912 85
1945c416 86Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>