Sat, 14 Jun 2008 15:16:09 +0200 <thp@perli.net>
[gpodder.git] / README
blob8d1bd1faebe8ec9c389b797a697f2fecf3c97e8d
1                                _
2                               | \      |   |
3                            _  |_/ _   _|  _|  _   _
4                           / \ |  / \ / | / | /_| |
5                           \_/ |  \_/ \_| \_| \_  |
6                          ._/ http://www.gpodder.org/
8            - -- == === ================================= === == -- -
9              Copyright  2005-2008 Thomas Perl and the gPodder Team
11  ==========================
12  License (see COPYING file)
13  ==========================
15  gPodder is free software; you can redistribute it and/or modify
16  it under the terms of the GNU General Public License as published by
17  the Free Software Foundation; either version 3 of the License, or
18  (at your option) any later version.
20  gPodder is distributed in the hope that it will be useful,
21  but WITHOUT ANY WARRANTY; without even the implied warranty of
22  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  GNU General Public License for more details.
25  You should have received a copy of the GNU General Public License
26  along with this program.  If not, see <http://www.gnu.org/licenses/>.
29  ============
30  Dependencies
31  ============
33    * python (>= 2.4)
34    * python-gtk2 (minimum 2.6, but >= 2.12 recommended)
35    * python-glade2
36    * python-feedparser
38  Additional dependencies for iPod synchronization support:
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)
46  Additional dependencies for "Update tags after download":
48    * python-eyed3 (for updating MP3 files)
49    * vorbis-tools (for updating OGG files)
51  Additional dependencies for converting OGGs to MP3s on iPod sync:
53    * oggdec (for decoding OGG files)
54    * lame (for encoding MP3 files)
56  Additional dependencies if you want direct BitTorrent download support:
58    * gnome-btdownload
60  Additional dependencies if you want Bluetooth file send support:
62    * python-bluez OR hcitool (for detecting nearby devices)
63    * gnome-obex-send OR bluetooth-sendto (for the file send operation)
65  Additional dependencies if you want Rockbox Cover Art syncing:
67    * python-imaging (Python Imaging Library, PIL)
69  Additional dependencies if you want to install from source:
71    * help2man
72    * python-dev
73    * intltool
74    * imagemagick
76  ============
77  Installation
78  ============
80  Extract the tar archive somewhere into your home directory and cd into 
81  the directory where you extracted it, for example:
83    tar xzvf gpodder-0.11.3.tar.gz
84    cd gpodder-0.11.3/
85    make install
87  If you have any problems, please visit the gPodder website or mail the 
88  gPodder mailing list (see below for more information).
90  =========================================
91  Feature requests, bug reports and patches
92  =========================================
94  Feature requests, bug report and patches should all be filed in our
95  Bugzilla at http://bugs.gpodder.org - for general discussion and questions,
96  please send a message to gpodder-devel (this is a subscriber-only list, so
97  you have to subscribe first before sending mail there).
99  For up to date information about gPodder, see the website and Wiki.
101    Homepage:       http://www.gpodder.org/
102    Wiki:           http://wiki.gpodder.org/
103    Bugzilla:       http://bugs.gpodder.org/
105    FAQs:           http://wiki.gpodder.org/wiki/FAQs
106    Mailing List:   gpodder-devel@berlios.de
107    IRC Channel:    #gpodder on FreeNode (irc.freenode.net)
109  Have fun with gPodder!
110  Thomas Perl <thpinfo.com>