gPodder 3.0.1 for Harmattan
[gpodder.git] / README
blob0c7ade4940263338a5c100c1499ac9cfb4b7a3a6
2                           ___         _    _           ____
3                      __ _| _ \___  __| |__| |___ _ _  |__ /
4                     / _` |  _/ _ \/ _` / _` / -_) '_|  |_ \
5                     \__, |_| \___/\__,_\__,_\___|_|   |___/
6                     |___/
7                           Media aggregator and podcast client
9   ............................................................................
11              Copyright  2005-2011 Thomas Perl and the gPodder Team
14  [ LICENSE ]
16     gPodder is free software; you can redistribute it and/or modify
17     it under the terms of the GNU General Public License as published by
18     the Free Software Foundation; either version 3 of the License, or
19     (at your option) any later version.
21     gPodder is distributed in the hope that it will be useful,
22     but WITHOUT ANY WARRANTY; without even the implied warranty of
23     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24     GNU General Public License for more details.
26     You should have received a copy of the GNU General Public License
27     along with this program. If not, see <http://www.gnu.org/licenses/>.
31  [ DEPENDENCIES ]
33     - Python 2.6 or newer              http://python.org/
34     - Feedparser 5.0.1 or newer        http://code.google.com/p/feedparser/
35     - mygpoclient 1.4 or newer         http://thp.io/2010/mygpoclient/
36     - Python D-Bus bindings
38     gPodder is still compatible with Python 2.5, but you might need to
39     install sqlite3 and json ("simplejson") manually. We reserve the
40     right to drop support for Python 2.5 in future point releases.
42     As an alternative to python-dbus on Mac OS X and Windows, you can use
43     the dummy (no-op) D-Bus module provided in "tools/fake-dbus-module/".
46  [ GTK UI - ADDITIONAL DEPENDENCIES ]
48     - PyGTK 2.12 or newer              http://pygtk.org/
51  [ QML UI - ADDITIONAL DEPENDENCIES ]
53     - Qt 4.7.1 or newer                http://qt.nokia.com/
54     - PySide 1.0.8 or newer            http://www.pyside.org/
55     - Qt Mobility 1.2 or newer         http://qt.nokia.com/
57     The QML UI depends on the QtMultimediaKit QML bindings for playing
58     back audio (libdeclarative-multimedia in Debian).
61  [ OPTIONAL DEPENDENCIES ]
63     - Bluetooth file sending: gnome-obex-send or bluetooth-sendto
64     - HTML shownotes: python-webkit
65     - Size detection on Windows: PyWin32
66     - Native OS X support: ige-mac-integration
69  [ BUILD DEPENDENCIES ]
71     - help2man
72     - intltool
75  [ TEST DEPENDENCIES ]
77     - python-minimock
78     - python-coverage
81  [ RUNNING AND INSTALLATION ]
83     To run gPodder from source, use "bin/gpodder".
85     To install gPodder system-wide, use "make install".
88  [ PORTABLE MODE / ROAMING PROFILES ]
90     The run-time environment variable GPODDER_HOME is used to set
91     the location for storing the database and downloaded files.
93     This can be used for multiple configurations or to store the
94     download directory directly on a MP3 player or USB disk:
96         export GPODDER_HOME=/media/usbdisk/gpodder-data/
99  [ MORE INFORMATION ]
101     - Homepage                         http://gpodder.org/
102     - Bug tracker                      http://bugs.gpodder.org/
103     - Mailing list                     http://freelists.org/list/gpodder
104     - IRC channel                      #gpodder on irc.freenode.net
106   ............................................................................
107              Last updated: 2011-11-06 by Thomas Perl <thp.io/about>