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