aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorcedricbonhomme <devnull@localhost>2010-03-24 09:41:42 +0100
committercedricbonhomme <devnull@localhost>2010-03-24 09:41:42 +0100
commita0180d8829e99815aa5b10e4752a88d68255f339 (patch)
tree4cf3b264c093fb4b7ed999d00fbb7c38693a2aa6 /README
parentMail notifications are sent through a new thread. Some improvements. (diff)
downloadnewspipe-a0180d8829e99815aa5b10e4752a88d68255f339.tar.gz
newspipe-a0180d8829e99815aa5b10e4752a88d68255f339.tar.bz2
newspipe-a0180d8829e99815aa5b10e4752a88d68255f339.zip
Added README file.
Diffstat (limited to 'README')
-rw-r--r--README51
1 files changed, 51 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 00000000..8884663c
--- /dev/null
+++ b/README
@@ -0,0 +1,51 @@
+==== Presentation ====
+pyAggr3g470r is a multi-threaded news aggregator with a web interface
+based on CherryPy. Articles are stored in a SQLite base.
+
+
+
+==== Features ====
+* notification by e-mail
+* language detection
+* TuxDroid support (for the notification of unread articles)
+
+
+
+==== Requierements ====
+=== Software required ===
+
+* Python (tested with 2.4 to 2.7)
+* CherryPy (version 3 and up)
+* sqlite
+
+=== Optional module ===
+These modules are not required but provides better features.
+
+== Language detection ==
+Name: oice.langdet
+Enable the detection of the language of articles.
+
+Installation:
+http://pypi.python.org/pypi/oice.langdet/
+
+
+== Histogram ==
+Name: matplotlib
+
+Installation:
+aptitude install python-matplotlib
+
+
+== Advanced monitoring ==
+Name: Gamin
+Enable a better monitoring of the base of feeds.
+
+Installation:
+aptitude install python-gamin
+
+http://people.gnome.org/~veillard/gamin/python.html
+
+
+==== License ====
+pyAggr3g470r is under GPLv3 license.
+http://www.gnu.org/licenses/gpl-3.0.txt \ No newline at end of file
bgstack15