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