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..
 100
 101         bin/gpodder              for the Gtk+ UI
 102         bin/gpodder --qml        for the QML UI
 103         bin/gpo                  for the command-line interface
 104
 105     To install gPodder system-wide, use "make install". By default, this
 106     will install *all* UIs and all translations. The following environment
 107     variables are processed by setup.py:
 108
 109         LINGUAS                  space-separated list of languages to install
 110         GPODDER_INSTALL_UIS      space-separated list of UIs to install
 111         GPODDER_MANPATH_NO_SHARE if set, install manpages to $PREFIX/man/man1
 112
 113     See setup.py for a list of recognized UIs.
 114
 115     Example: Install the CLI and Gtk UI with German and Dutch translations:
 116
 117         export LINGUAS="de nl"
 118         export GPODDER_INSTALL_UIS="cli gtk"
 119         make install
 120
 121     The "make install" target also supports DESTDIR and PREFIX for installing
 122     into an alternative root (default /) and prefix (default /usr):
 123
 124         make install DESTDIR=tmp/ PREFIX=/usr/local/
 125
 126
 127  [ PYTHON 3 SUPPORT ]
 128
 129     The CLI version of gPodder (bin/gpo) and the QML UI are compatible with
 130     Python 3 after converting the codebase with the 2to3 utility:
 131
 132       2to3 -w bin/* src share/gpodder/extensions
 133
 134     You will also need a copy of "mygpoclient" converted using 2to3 and
 135     a copy of "feedparser" converted using 2to3 (see the feedparser README
 136     for details on how to get it set up on Python 3, including sgmllib).
 137
 138     Please note that the Gtk UI is not compatible with Python 3 (it will
 139     be once we migrate the codebase to Gtk3/GObject Introspection).
 140
 141     The QML UI has been tested with PySide (Git revision a90f3bc) and
 142     Python 3.2.2 - you can use the PySide buildscripts to build PySide:
 143
 144         http://github.com/PySide/BuildScripts
 145
 146     As of February 2012, Python 3 support is still experimental. Please
 147     report any bugs that you find to the gPodder bug tracker (see below).
 148
 149
 150  [ PORTABLE MODE / ROAMING PROFILES ]
 151
 152     The run-time environment variable GPODDER_HOME is used to set
 153     the location for storing the database and downloaded files.
 154
 155     This can be used for multiple configurations or to store the
 156     download directory directly on a MP3 player or USB disk:
 157
 158         export GPODDER_HOME=/media/usbdisk/gpodder-data/
 159
 160  [ LOGGING ]
 161
 162     By default, gPodder writes log files to $GPODDER_HOME/Logs/ and removes
 163     them after a certain amount of times. To avoid this behavior, you can set
 164     the environment variable GPODDER_WRITE_LOGS to "no", e.g:
 165
 166         export GPODDER_WRITE_LOGS=no
 167
 168  [ EXTENSIONS ]
 169
 170     Extensions are normally loaded from gPodder's "extensions/" folder (in
 171     share/gpodder/extensions/) and from $GPODDER_HOME/Extensions/ - you can
 172     override this by setting an environment variable:
 173
 174         export GPODDER_EXTENSIONS="/path/to/extension1.py extension2.py"
 175
 176     In addition to that, if you want to disable loading of all extensions,
 177     you can do this by setting the following environment variable to a non-
 178     empty value:
 179
 180         export GPODDER_DISABLE_EXTENSIONS=yes
 181
 182     If you want to report a bug, please try to disable all extensions and
 183     check if the bug still appears to see if an extension causes the bug.
 184
 185
 186  [ MORE INFORMATION ]
 187
 188     - Homepage                         http://gpodder.org/
 189     - Bug tracker                      http://bugs.gpodder.org/
 190     - Mailing list                     http://freelists.org/list/gpodder
 191     - IRC channel                      #gpodder on irc.freenode.net
 192
 193   ............................................................................
 194              Last updated: 2012-02-24 by Thomas Perl <thp.io/about>
 195