README

   1                                _
   2                            _  | \ _   _|  _|  _   _
   3                           / \ |_// \ / | / | /_| |
   4                           \_/ |  \_/ \_| \_| \_  |
   5                          ._/      http://gpodder.org/
   6
   7            - -- == === ================================= === == -- -
   8              Copyright  2005-2011 Thomas Perl and the gPodder Team
   9
  10  ==========================
  11  License (see COPYING file)
  12  ==========================
  13
  14  gPodder is free software; you can redistribute it and/or modify
  15  it under the terms of the GNU General Public License as published by
  16  the Free Software Foundation; either version 3 of the License, or
  17  (at your option) any later version.
  18
  19  gPodder is distributed in the hope that it will be useful,
  20  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  GNU General Public License for more details.
  23
  24  You should have received a copy of the GNU General Public License
  25  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26
  27  ============
  28  Dependencies
  29  ============
  30
  31    * python (>= 2.5) with sqlite3 and json support
  32      Python 2.6 includes "json"; for Python < 2.6, install "simplejson"
  33    * python-gtk2 (>= 2.12)
  34    * python-feedparser
  35    * python-mygpoclient (>= 1.4; http://thp.io/2010/mygpoclient/)
  36    * python-dbus
  37
  38  As an alternative to python-dbus, you can use the fake D-Bus module
  39  provided in "tools/fake-dbus-module/".
  40
  41  Dependencies for the QML UI:
  42
  43    * Qt (>= 4.7.0)
  44    * PySide (>= 1.0.0~rc1)
  45    * Qt Mobility >= 1.1 Declarative Components
  46      (qtm-declarative from the FN PPA; use ppa:forumnokia/fn-ppa)
  47    * Phonon GStreamer backend (Xine backend has problems)
  48      (on Debian/Ubuntu, use phonon-backend-gstreamer)
  49
  50  Additional dependencies if you want Bluetooth file send support:
  51
  52    * gnome-obex-send OR bluetooth-sendto
  53
  54  Additional dependencies for HTML episode shownotes:
  55
  56    * python-webkit (Python bindings for WebKitGTK+)
  57
  58  Additional dependencies for gPodder on Windows:
  59
  60    * PyWin32 (http://sourceforge.net/projects/pywin32/)
  61
  62  Additional dependencies for gPodder on Mac OS X:
  63
  64    * ige-mac-integration (optional; when using the quartz GDK backend)
  65
  66  Additional dependencies if you want to install from source:
  67
  68    * help2man
  69    * python-dev
  70    * intltool
  71
  72  Dependencies for running unittest/doctests ("make unittest"):
  73
  74    * python-minimock
  75    * python-coverage (optional; recommended)
  76
  77  ============
  78  Installation
  79  ============
  80
  81  Extract the tar archive somewhere into your home directory and cd into
  82  the directory where you extracted it, for example:
  83
  84    tar xzvf gpodder-2.11.tar.gz
  85    cd gpodder-2.11/
  86    make install
  87
  88  If you have any problems, please visit the gPodder website or mail the
  89  gPodder mailing list (see below for more information).
  90
  91  ================================
  92  Portable mode / roaming profiles
  93  ================================
  94
  95  You can set the environment variable GPODDER_HOME to set the location for
  96  storing the database and downloaded files.
  97
  98  You can use this to have different configurations for gPodder or to put
  99  gPodder's data directly on your MP3 player or USB disk, for example:
 100
 101     export GPODDER_HOME=/media/usbdisk/gpodder-data/
 102     gpodder
 103
 104  =========================================
 105  Feature requests, bug reports and patches
 106  =========================================
 107
 108  Feature requests, bug report and patches should all be filed in our
 109  Bugzilla at http://bugs.gpodder.org - for general discussion and questions,
 110  please send a message to gpodder-devel (this is a subscriber-only list, so
 111  you have to subscribe first before sending mail there).
 112
 113  For up to date information about gPodder, see the website and Wiki.
 114
 115    Homepage:       http://gpodder.org/
 116    Wiki:           http://wiki.gpodder.org/
 117    Bugzilla:       http://bugs.gpodder.org/
 118
 119    FAQs:           http://wiki.gpodder.org/wiki/FAQs
 120    Mailing List:   gpodder-devel@berlios.de
 121    IRC Channel:    #gpodder on FreeNode (irc.freenode.net)
 122
 123  Have fun with gPodder!
 124  Thomas Perl <thp.io>
 125