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