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)
  33    * python-gtk2 (>= 2.12)
  34    * python-feedparser
  35    * python-dbus (optional, but highly recommended)
  36
  37  Additional dependencies for iPod synchronization support:
  38
  39    * One of the following metadata libraries:
  40      - python-pymad (preferred; MAD MP3 decoder Python bindings)
  41      - python-eyed3 (alternative to pymad; eyeD3 Python bindings)
  42    * python-gpod (libgpod's Python bindings)
  43    * mplayer (OPTIONAL; if you want video podcast length detection)
  44
  45  Additional dependencies for MTP-based device synchronization support:
  46
  47    * python-pymtp (libmtp's Python bindings; nick125.com/projects/pymtp)
  48
  49  Additional dependencies for converting OGGs to MP3s on iPod sync:
  50
  51    * oggdec (for decoding OGG files)
  52    * lame (for encoding MP3 files)
  53
  54  Additional dependencies if you want Bluetooth file send support:
  55
  56    * gnome-obex-send OR bluetooth-sendto
  57
  58  Additional dependencies if you want Rockbox Cover Art syncing:
  59
  60    * python-imaging (Python Imaging Library, PIL)
  61
  62  Additional dependencies for gtkhtml2 episode shownotes:
  63
  64    * python-gtkhtml2
  65
  66  Additional dependencies for gPodder on Windows:
  67
  68    * PyWin32 (http://sourceforge.net/projects/pywin32/)
  69
  70  Additional dependencies for the Soundcloud plug-in:
  71
  72    * Python >= 2.6 (as this includes the "json" module) OR
  73    * Python < 2.6 with the "simplejson" module (Debian: python-simplejson)
  74
  75  Additional dependencies if you want to install from source:
  76
  77    * help2man
  78    * python-dev
  79    * intltool
  80
  81  Dependencies for running unittest/doctests ("make unittest"):
  82
  83    * python-minimock
  84    * python-coverage (optional; recommended)
  85
  86  ============
  87  Installation
  88  ============
  89
  90  Extract the tar archive somewhere into your home directory and cd into
  91  the directory where you extracted it, for example:
  92
  93    tar xzvf gpodder-2.0.tar.gz
  94    cd gpodder-2.0/
  95    make install
  96
  97  If you have any problems, please visit the gPodder website or mail the
  98  gPodder mailing list (see below for more information).
  99
 100  ================================
 101  Portable mode / roaming profiles
 102  ================================
 103
 104  You can set the environment variables GPODDER_HOME and GPODDER_DOWNLOAD_DIR
 105  to point to locations for storing the database and downloaded files:
 106
 107     GPODDER_HOME ........... location for configuration and database
 108     GPODDER_DOWNLOAD_DIR ... location for downloaded episodes
 109
 110  You can use this to have different configurations for gPodder or to put
 111  gPodder's data directly on your MP3 player or USB disk, for example:
 112
 113     export GPODDER_HOME=/media/usbdisk/gpodder-data/
 114     export GPODDER_DOWLOAD_DIR=/media/usbdisk/podcasts/
 115     gpodder
 116
 117  =========================================
 118  Feature requests, bug reports and patches
 119  =========================================
 120
 121  Feature requests, bug report and patches should all be filed in our
 122  Bugzilla at http://bugs.gpodder.org - for general discussion and questions,
 123  please send a message to gpodder-devel (this is a subscriber-only list, so
 124  you have to subscribe first before sending mail there).
 125
 126  For up to date information about gPodder, see the website and Wiki.
 127
 128    Homepage:       http://gpodder.org/
 129    Wiki:           http://wiki.gpodder.org/
 130    Bugzilla:       http://bugs.gpodder.org/
 131
 132    FAQs:           http://wiki.gpodder.org/wiki/FAQs
 133    Mailing List:   gpodder-devel@berlios.de
 134    IRC Channel:    #gpodder on FreeNode (irc.freenode.net)
 135
 136  Have fun with gPodder!
 137  Thomas Perl <thpinfo.com>
 138