README

   1                                _
   2                            _  | \ _   _|  _|  _   _
   3                           / \ |_// \ / | / | /_| |
   4                           \_/ |  \_/ \_| \_| \_  |
   5                          ._/      http://gpodder.org/
   6
   7            - -- == === ================================= === == -- -
   8              Copyright  2005-2010 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  ============
  29  Dependencies
  30  ============
  31
  32    * python (>= 2.5) with sqlite3 support
  33    * python-gtk2 (>= 2.12)
  34    * python-feedparser
  35    * python-mygpoclient (>= 1.4; http://thp.io/2010/mygpoclient/)
  36    * python-dbus (optional, but highly recommended)
  37
  38  If your Python installation does not come with "sqlite3" support,
  39  you can either re-compile Python with support for sqlite3 or use
  40  the "pysqlite" package from http://code.google.com/p/pysqlite/
  41
  42  Additional dependencies for iPod synchronization support:
  43
  44    * python-gpod (libgpod's Python bindings)
  45    * At least one of the following packages:
  46      - python-gst0.10 (GStreamer Python bindings)
  47      - mplayer (recommended for video podcasts)
  48      - python-eyed3 (eyeD3 library)
  49
  50  Additional dependencies for MTP-based device synchronization support:
  51
  52    * libmtp (>= 1.0.0)
  53      Please note that the previously-required "pymtp" module is now included in
  54      the gPodder distribution as "gpodder.gpopymtp", and therefore no longer
  55      needed as special dependency. You still need a recent version of libmtp.
  56
  57  Additional dependencies for converting OGGs to MP3s on iPod sync:
  58
  59    * oggdec (for decoding OGG files)
  60    * lame (for encoding MP3 files)
  61
  62  Additional dependencies if you want Bluetooth file send support:
  63
  64    * gnome-obex-send OR bluetooth-sendto
  65
  66  Additional dependencies if you want Rockbox Cover Art syncing:
  67
  68    * python-imaging (Python Imaging Library, PIL)
  69
  70  Additional dependencies for HTML episode shownotes:
  71
  72    * python-webkit (Python bindings for WebKitGTK+)
  73
  74  Additional dependencies for gPodder on Windows:
  75
  76    * PyWin32 (http://sourceforge.net/projects/pywin32/)
  77
  78  Additional dependencies for gPodder on Mac OS X:
  79
  80    * ige-mac-integration (optional; when using the quartz GDK backend)
  81
  82  Additional dependencies for the Soundcloud plug-in:
  83
  84    * Python >= 2.6 (as this includes the "json" module) OR
  85    * Python < 2.6 with the "simplejson" module (Debian: python-simplejson)
  86
  87  Additional dependencies if you want to install from source:
  88
  89    * help2man
  90    * python-dev
  91    * intltool
  92
  93  Dependencies for running unittest/doctests ("make unittest"):
  94
  95    * python-minimock
  96    * python-coverage (optional; recommended)
  97
  98  ============
  99  Installation
 100  ============
 101
 102  Extract the tar archive somewhere into your home directory and cd into
 103  the directory where you extracted it, for example:
 104
 105    tar xzvf gpodder-2.9.tar.gz
 106    cd gpodder-2.9/
 107    make install
 108
 109  If you have any problems, please visit the gPodder website or mail the
 110  gPodder mailing list (see below for more information).
 111
 112  ================================
 113  Portable mode / roaming profiles
 114  ================================
 115
 116  You can set the environment variables GPODDER_HOME and GPODDER_DOWNLOAD_DIR
 117  to point to locations for storing the database and downloaded files:
 118
 119     GPODDER_HOME ........... location for configuration and database
 120     GPODDER_DOWNLOAD_DIR ... location for downloaded episodes
 121
 122  You can use this to have different configurations for gPodder or to put
 123  gPodder's data directly on your MP3 player or USB disk, for example:
 124
 125     export GPODDER_HOME=/media/usbdisk/gpodder-data/
 126     export GPODDER_DOWLOAD_DIR=/media/usbdisk/podcasts/
 127     gpodder
 128
 129  =========================================
 130  Feature requests, bug reports and patches
 131  =========================================
 132
 133  Feature requests, bug report and patches should all be filed in our
 134  Bugzilla at http://bugs.gpodder.org - for general discussion and questions,
 135  please send a message to gpodder-devel (this is a subscriber-only list, so
 136  you have to subscribe first before sending mail there).
 137
 138  For up to date information about gPodder, see the website and Wiki.
 139
 140    Homepage:       http://gpodder.org/
 141    Wiki:           http://wiki.gpodder.org/
 142    Bugzilla:       http://bugs.gpodder.org/
 143
 144    FAQs:           http://wiki.gpodder.org/wiki/FAQs
 145    Mailing List:   gpodder-devel@berlios.de
 146    IRC Channel:    #gpodder on FreeNode (irc.freenode.net)
 147
 148  Have fun with gPodder!
 149  Thomas Perl <thp.io>
 150