aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCédric Bonhomme <kimble.mandel@gmail.com>2012-12-07 07:25:30 +0100
committerCédric Bonhomme <kimble.mandel@gmail.com>2012-12-07 07:25:30 +0100
commitea421c7e7b411129762d2dbc5a6e4a03b83ee5c7 (patch)
tree8b429e56dd6dc78d5510e0655d54ce5f4607825c /README.md
parentUpdated README. (diff)
downloadnewspipe-ea421c7e7b411129762d2dbc5a6e4a03b83ee5c7.tar.gz
newspipe-ea421c7e7b411129762d2dbc5a6e4a03b83ee5c7.tar.bz2
newspipe-ea421c7e7b411129762d2dbc5a6e4a03b83ee5c7.zip
Updated README file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 3 insertions, 7 deletions
diff --git a/README.md b/README.md
index 8383884c..032008ad 100644
--- a/README.md
+++ b/README.md
@@ -3,11 +3,13 @@ pyAggr3g470r
#### A simple Python news aggregator.
+
Presentation
------------
[pyAggr3g470r](https://bitbucket.org/cedricbonhomme/pyaggr3g470r/) is a news aggregator with a web interface
based on [CherryPy](http://cherrypy.org/). Articles are stored in a [MongoDB](http://api.mongodb.org/python/current/) base.
+A documentation is available [here](https://pyaggr3g470r.readthedocs.org/).
Features
@@ -21,7 +23,6 @@ Features
* generation of QR codes with URLs of articles.
-
Requierements
-------------
@@ -33,17 +34,13 @@ Software required
* [CherryPy](http://cherrypy.org/) >= 3.2.2 and [Mako](http://www.makotemplates.org/) (for **pyAggr3g470r.py**, the Web interface);
* [BeautifulSoup](http://www.crummy.com/software/BeautifulSoup/) >= 4.1.3 (automatically find a feed in a HTML page).
-
Optional module
These modules are not required but enables more features:
+
* lxml and Genshi;
* Python Imaging Library for the generation of QR codes.
-Not yet tested with Python 3.2. If you want to install these modules:
-
- $ sudo aptitude install python-lxml python-genshi
-
Backup
------
@@ -61,7 +58,6 @@ If you wish and if you like pyAggr3g470r, you can donate via bitcoin. My bitcoin
Thank you!
-
License
------------
[pyAggr3g470r](https://bitbucket.org/cedricbonhomme/pyaggr3g470r/) is under [GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt) license.
bgstack15