summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWaldir Pimenta <[email protected]>2012-12-12 05:20:32 +0000
committerWaldir Pimenta <[email protected]>2012-12-12 05:20:32 +0000
commit3a5d1b2802f8827b43309d7e05a1b8feaba45f6e (patch)
tree2d45ca51793e0c01c8f4729e9516219d7a7e6145 /README.md
parent88e8fb3a7132d1321ab65b66a19a67df890c402d (diff)
rename README to README.md to make Github's markdown parser kick in
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..da614a004
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+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
+