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