aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 9 insertions, 9 deletions
diff --git a/README b/README
index b725dba6..8c7f0443 100644
--- a/README
+++ b/README
@@ -1,10 +1,10 @@
-==== Presentation ====
+! Presentation
pyAggr3g470r is a multi-threaded news aggregator with a web interface
based on CherryPy. Articles are stored in a SQLite base.
-==== Features ====
+! Features
* notification of new articles by e-mail for selected feeds;
* export articles (HTML and raw text);
* mark or unmark an article as favorites;
@@ -13,8 +13,8 @@ based on CherryPy. Articles are stored in a SQLite base.
-==== Requierements ====
-=== Software required ===
+! Requierements
+!! Software required
* Python 2.7.*
* SQLite
@@ -23,7 +23,7 @@ based on CherryPy. Articles are stored in a SQLite base.
* BeautifulSoup
-=== Optional module ===
+!! Optional module
These modules are not required but provides better features.
These modules are:
* oice.langdet
@@ -31,7 +31,7 @@ These modules are:
If you want to install these modules:
-== Language detection ==
+!!! Language detection
Name: oice.langdet
Enable the detection of the language of articles.
@@ -40,7 +40,7 @@ http://pypi.python.org/pypi/oice.langdet/
Download the archive, decompress, go to the folder and type:
python setup.py install
-== Advanced monitoring ==
+!!! Advanced monitoring
Name: Gamin
Enable a better monitoring of the base of feeds.
@@ -51,6 +51,6 @@ http://people.gnome.org/~veillard/gamin/python.html
-==== License ====
+! License
pyAggr3g470r is under GPLv3 license.
-http://www.gnu.org/licenses/gpl-3.0.txt
+http://www.gnu.org/licenses/gpl-3.0.txt \ No newline at end of file
bgstack15