README

   1
   2                           ___         _    _           ____
   3                      __ _| _ \___  __| |__| |___ _ _  |__ /
   4                     / _` |  _/ _ \/ _` / _` / -_) '_|  |_ \
   5                     \__, |_| \___/\__,_\__,_\___|_|   |___/
   6                     |___/
   7                           Media aggregator and podcast client
   8
   9   ............................................................................
  10
  11              Copyright  2005-2012 Thomas Perl and the gPodder Team
  12
  13
  14  [ LICENSE ]
  15
  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.
  20
  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.
  25
  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/>.
  28
  29
  30
  31  [ DEPENDENCIES ]
  32
  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
  37
  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.
  41
  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/".
  44
  45     For quick testing, you can use the script tools/localdepends.py to
  46     install local copies of feedparser and mygpoclient into "src/" from
  47     PyPI. With this, you get a self-contained gPodder CLI/WebUI codebase.
  48
  49
  50  [ GTK UI - ADDITIONAL DEPENDENCIES ]
  51
  52     - PyGTK 2.12 or newer              http://pygtk.org/
  53
  54
  55  [ QML UI - ADDITIONAL DEPENDENCIES ]
  56
  57     - Qt 4.7.1 or newer                http://qt.nokia.com/
  58     - PySide 1.0.8 or newer            http://www.pyside.org/
  59     - Qt Mobility 1.2 or newer         http://qt.gitorious.org/qt-mobility
  60     - Qt Quick Components              http://qt.gitorious.org/qt-components
  61
  62     The QML UI depends on the QtMultimediaKit QML bindings for playing
  63     back audio (libdeclarative-multimedia in Debian).
  64
  65     The QML UI now also depends on Qt Quick Components. On MeeGo 1.2 Harmattan,
  66     these components are pre-installed. You can install them on your Desktop by
  67     checking out the code from the qt-components Git repository and running the
  68     "./configure" script with the "-meego" parameter (+ the usual make install).
  69
  70     You might also need to copy the theme from /usr/share/themes/blanco/ on a
  71     MeeGo 1.2 Harmattan device to your development machine in order for all UI
  72     elements to be displayed correctly. Alternatively, you can use the free
  73     "darko" theme from: https://github.com/jpavelek/meego-handset-theme-darko
  74
  75
  76  [ OPTIONAL DEPENDENCIES ]
  77
  78     - Bluetooth file sending: gnome-obex-send or bluetooth-sendto
  79     - HTML shownotes: python-webkit
  80     - Size detection on Windows: PyWin32
  81     - Native OS X support: ige-mac-integration
  82
  83
  84  [ BUILD DEPENDENCIES ]
  85
  86     - help2man
  87     - intltool
  88
  89
  90  [ TEST DEPENDENCIES ]
  91
  92     - python-minimock
  93     - python-coverage
  94
  95
  96  [ RUNNING AND INSTALLATION ]
  97
  98     To run gPodder from source, use "bin/gpodder".
  99
 100     To install gPodder system-wide, use "make install".
 101
 102
 103  [ PYTHON 3 SUPPORT ]
 104
 105     The CLI version of gPodder (bin/gpo) is compatible with Python 3
 106     after converting the codebase with the 2to3 utility:
 107
 108       2to3 -w bin/* src/gpodder/
 109
 110     You will also need a copy of "mygpoclient" converted using 2to3 and
 111     a copy of "feedparser" converted using 2to3 (see the feedparser README
 112     for details on how to get it set up on Python 3, including sgmllib).
 113
 114     Please note that the Gtk UI is not compatible with Python 3 (it will
 115     be once we migrate the codebase to Gtk3/GObject Introspection), and
 116     the QML UI - while theoretically compatible - has not been tested
 117     with Python 3 yet due to the Python 3 support status in PySide.
 118
 119     As of January 2012, Python 3 support is still experimental. Please
 120     report any bugs that you find to the gPodder bug tracker (see below).
 121
 122
 123  [ PORTABLE MODE / ROAMING PROFILES ]
 124
 125     The run-time environment variable GPODDER_HOME is used to set
 126     the location for storing the database and downloaded files.
 127
 128     This can be used for multiple configurations or to store the
 129     download directory directly on a MP3 player or USB disk:
 130
 131         export GPODDER_HOME=/media/usbdisk/gpodder-data/
 132
 133
 134  [ MORE INFORMATION ]
 135
 136     - Homepage                         http://gpodder.org/
 137     - Bug tracker                      http://bugs.gpodder.org/
 138     - Mailing list                     http://freelists.org/list/gpodder
 139     - IRC channel                      #gpodder on irc.freenode.net
 140
 141   ............................................................................
 142              Last updated: 2012-01-10 by Thomas Perl <thp.io/about>
 143