Go to file
Thomas Perl 4b781d92ee CLI: Avoid encoding issues for podcast titles (bug 1570)
Another episode of "why oh why does Python default to ascii?".
2012-02-22 21:24:19 +01:00
.tx Add Transifex configuration file 2011-08-04 12:24:22 +02:00
bin CLI: Avoid encoding issues for podcast titles (bug 1570) 2012-02-22 21:24:19 +01:00
data Extensions/Gtk: Move manager to preferences dialog 2012-02-21 13:50:33 +01:00
draft New draft: Gtk+ UI directory prototype 2011-06-02 23:28:58 +02:00
examples Extensions: Add on_load() / on_unload() support 2012-02-21 15:13:18 +01:00
src/gpodder Check for sqlite3 dependency + update README 2012-02-22 20:07:55 +01:00
tools Tools: Self-contained dependency downloader 2012-02-11 14:12:20 +01:00
COPYING Upgrade gPodder to GPLv3 2007-08-29 18:30:26 +00:00
MANIFEST.in gPodder 3.0.0 "397/D" released 2011-11-07 00:03:43 +01:00
README Check for sqlite3 dependency + update README 2012-02-22 20:07:55 +01:00
makefile Makefile: Use $(MAKE) to use the current make 2012-02-22 19:46:01 +01:00
setup.py Update copyright years (add 2012) 2012-01-09 21:19:24 +01:00

README

                          ___         _    _           ____
                     __ _| _ \___  __| |__| |___ _ _  |__ /
                    / _` |  _/ _ \/ _` / _` / -_) '_|  |_ \
                    \__, |_| \___/\__,_\__,_\___|_|   |___/
                    |___/
                          Media aggregator and podcast client

  ............................................................................

             Copyright  2005-2012 Thomas Perl and the gPodder Team


 [ LICENSE ]

    gPodder is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    gPodder is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program. If not, see <http://www.gnu.org/licenses/>.



 [ DEPENDENCIES ]

    - Python 2.6 or newer              http://python.org/
    - "sqlite3" Python module          (usually included with Python)
    - Feedparser 5.0.1 or newer        http://code.google.com/p/feedparser/
    - mygpoclient 1.4 or newer         http://thp.io/2010/mygpoclient/
    - Python D-Bus bindings

    gPodder might still work with Python 2.5, but you may need to
    install the json module ("simplejson") manually. We reserve the
    right to drop support for Python 2.5 in future point releases.

    As an alternative to python-dbus on Mac OS X and Windows, you can use
    the dummy (no-op) D-Bus module provided in "tools/fake-dbus-module/".

    For quick testing, you can use the script tools/localdepends.py to
    install local copies of feedparser and mygpoclient into "src/" from
    PyPI. With this, you get a self-contained gPodder CLI/WebUI codebase.


 [ GTK UI - ADDITIONAL DEPENDENCIES ]

    - PyGTK 2.12 or newer              http://pygtk.org/


 [ QML UI - ADDITIONAL DEPENDENCIES ]

    - Qt 4.7.1 or newer                http://qt.nokia.com/
    - PySide 1.0.8 or newer            http://www.pyside.org/
    - Qt Mobility 1.2 or newer         http://qt.gitorious.org/qt-mobility
    - Qt Quick Components              http://qt.gitorious.org/qt-components

    The QML UI depends on the QtMultimediaKit QML bindings for playing
    back audio (libdeclarative-multimedia in Debian).

    The QML UI now also depends on Qt Quick Components. On MeeGo 1.2 Harmattan,
    these components are pre-installed. You can install them on your Desktop by
    checking out the code from the qt-components Git repository and running the
    "./configure" script with the "-meego" parameter (+ the usual make install).

    You might also need to copy the theme from /usr/share/themes/blanco/ on a
    MeeGo 1.2 Harmattan device to your development machine in order for all UI
    elements to be displayed correctly. Alternatively, you can use the free
    "darko" theme from: https://github.com/jpavelek/meego-handset-theme-darko


 [ OPTIONAL DEPENDENCIES ]

    - Bluetooth file sending: gnome-obex-send or bluetooth-sendto
    - HTML shownotes: python-webkit
    - Size detection on Windows: PyWin32
    - Native OS X support: ige-mac-integration


 [ BUILD DEPENDENCIES ]

    - help2man
    - intltool


 [ TEST DEPENDENCIES ]

    - python-minimock
    - python-coverage


 [ RUNNING AND INSTALLATION ]

    To run gPodder from source, use "bin/gpodder".

    To install gPodder system-wide, use "make install".


 [ PYTHON 3 SUPPORT ]

    The CLI version of gPodder (bin/gpo) is compatible with Python 3
    after converting the codebase with the 2to3 utility:

      2to3 -w bin/* src/gpodder/

    You will also need a copy of "mygpoclient" converted using 2to3 and
    a copy of "feedparser" converted using 2to3 (see the feedparser README
    for details on how to get it set up on Python 3, including sgmllib).

    Please note that the Gtk UI is not compatible with Python 3 (it will
    be once we migrate the codebase to Gtk3/GObject Introspection), and
    the QML UI - while theoretically compatible - has not been tested
    with Python 3 yet due to the Python 3 support status in PySide.

    As of January 2012, Python 3 support is still experimental. Please
    report any bugs that you find to the gPodder bug tracker (see below).


 [ PORTABLE MODE / ROAMING PROFILES ]

    The run-time environment variable GPODDER_HOME is used to set
    the location for storing the database and downloaded files.

    This can be used for multiple configurations or to store the
    download directory directly on a MP3 player or USB disk:

        export GPODDER_HOME=/media/usbdisk/gpodder-data/


 [ MORE INFORMATION ]

    - Homepage                         http://gpodder.org/
    - Bug tracker                      http://bugs.gpodder.org/
    - Mailing list                     http://freelists.org/list/gpodder
    - IRC channel                      #gpodder on irc.freenode.net

  ............................................................................
             Last updated: 2012-01-10 by Thomas Perl <thp.io/about>