]> git.wh0rd.org - tt-rss.git/blame - README
update translations
[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
c4587ce3
AD
16Other bundled libraries:
17
18 Prototype javascript library, from http://prototype.conio.net/
19 Script.aculo.us javascript library, http://http://script.aculo.us/
20 MagpieRSS feed parser, http://magpierss.sourceforge.net/
21 SimplePie feed parser, http://simplepie.org/
5a4ef316 22
3baeeeca 23Licensed under GNU GPL version 2
8983d995
AD
24
25Features Overview
26=================
27
28 Updates: http://tt-rss.spb.ru/trac/wiki/FeatureList
29
30 * Server-side application, user only needs a web browser
52cc33a0 31 * Supports RSS, RDF, Atom feeds using Magpie or SimplePie library
8983d995
AD
32 * Supports OPML import/export
33 * Easy setup and configuration
34 * Streamlined interface using XmlHttpRequest (or AJAX for laypeople)
35
36Requirements
37============
38
39 * Compatible browser on the client side
40
41 Basically, Firefox, Konqueror or MSIE6 are okay. See here
42 for more information:
43
44 http://tt-rss.spb.ru/trac/wiki/CompatibleBrowsers
45
46 * Web server, for example Apache
47 * PHP (requires PHP4 DOMXML extension)
8983d995
AD
48 * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required)
49
1205abd0
AD
50 * XML-RPC for PHP library for XML-RPC support. Optional.
51
52 http://phpxmlrpc.sourceforge.net
53
8983d995
AD
54Installation Notes
55==================
56
57 Updates: http://tt-rss.spb.ru/trac/wiki/InstallationNotes
58
59 * If you are upgrading from the previous version, don't forget to update
60 schema and logout.
61
62 * icons directory should be writable to your httpd user if you plan on
63 using feed icons
64
65 * Leave DB_HOST empty if you want to connect to database via unix socket
66
67 * For PostgreSQL don't forget to create database with UTF-8 encoding
68
69 createdb -E utf-8 -O owner_user database)
70
71 * Don't forget to change your password from default value on your first login
72
73 * Check your config.php for blank lines out of PHP code tags (e.g.
74 before <? and after ?>), See #1
75
c017149c
AD
76 * Default username:password for multiuser mode is admin:password.
77
8983d995
AD
78See also
79========
80
81 * FAQ: http://tt-rss.spb.ru/trac/wiki/FrequentlyAskedQuestions
82 * Forum: http://tt-rss.spb.ru/forum
83 * Wiki: http://tt-rss.spb.ru/trac/wiki/WikiStart
84 * Bug Tracker: http://tt-rss.spb.ru/trac/report
85
86Contact
87=======
78800912 88
1f8361c4 89Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>