summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Dolgov <[email protected]>2012-12-11 21:47:14 -0800
committerAndrew Dolgov <[email protected]>2012-12-11 21:47:14 -0800
commit02872c30ed96a7556233fe3c6e3fc2913217fbdb (patch)
treeddcfa10871af958d7384d528cf2f27a285d8660d /README.md
parent2a91b6ff78145a3ed955f7617b00e404ad6357b6 (diff)
parent763f8c92805e10bba752d002729e8f083a6bf7c8 (diff)
Merge pull request #33 from waldir/master
Adjust README file so it is correctly parsed by github
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..0371f80cc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+Tiny Tiny RSS
+=============
+
+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.
+
+http://tt-rss.org
+
+Licensed under GNU GPL version 2
+
+Copyright (c) 2005-2010 Andrew Dolgov (unless explicitly stated otherwise).
+
+## Requirements
+
+* 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
+
+http://tt-rss.org/wiki/InstallationNotes
+
+## See also
+
+* FAQ: http://tt-rss.org/wiki/FrequentlyAskedQuestions
+* Forum: http://tt-rss.org/forum
+* Wiki: http://tt-rss.org/wiki/WikiStart