Save the database as soon as possible.
[gpodder.git] / README
blob5e5bfa15d1ff5c6efd4308e0280e0cdde891fd0d
1                                _
2                            _  | \     _|  _|  _
3                           / \ |_// \ / | / | /_| |`
4                           \_/ |  \_/ \_| \_| \_  |
5                          ._/      http://gpodder.org/
7            - -- == === ================================= === == -- -
8              Copyright  2005-2008 Thomas Perl and the gPodder Team
10  ==========================
11  License (see COPYING file)
12  ==========================
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.
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.
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/>.
28  ============
29  Dependencies
30  ============
32    * python (>= 2.5)
33    * python-gtk2 (minimum 2.6, but >= 2.12 recommended)
34    * python-glade2
35    * python-feedparser
37  Additional dependencies for iPod synchronization support:
39    * One of the following metadata libraries:
40      - python-pymad (preferred; MAD MP3 decoder Python bindings)
41      - python-eyed3 (alternative to pymad; eyeD3 Python bindings)
42    * python-gpod (libgpod's Python bindings)
43    * mplayer (OPTIONAL; if you want video podcast length detection)
45  Additional dependencies for MTP-based device synchronization support:
47    * python-pymtp (libmtp's Python bindings; nick125.com/projects/pymtp)
49  Additional dependencies for "Update tags after download":
51    * python-eyed3 (for updating MP3 files)
52    * vorbis-tools (for updating OGG files)
54  Additional dependencies for converting OGGs to MP3s on iPod sync:
56    * oggdec (for decoding OGG files)
57    * lame (for encoding MP3 files)
59  Additional dependencies if you want Bluetooth file send support:
61    * python-bluez OR hcitool (for detecting nearby devices)
62    * gnome-obex-send OR bluetooth-sendto (for the file send operation)
64  Additional dependencies if you want Rockbox Cover Art syncing:
66    * python-imaging (Python Imaging Library, PIL)
68  Additional dependencies for gtkhtml2 episode shownotes:
70    * python-gtkhtml2
72  Additional dependencies if you want to install from source:
74    * help2man
75    * python-dev
76    * intltool
77    * imagemagick
79  ============
80  Installation
81  ============
83  Extract the tar archive somewhere into your home directory and cd into 
84  the directory where you extracted it, for example:
86    tar xzvf gpodder-0.14.1.tar.gz
87    cd gpodder-0.14.1/
88    make install
90  If you have any problems, please visit the gPodder website or mail the 
91  gPodder mailing list (see below for more information).
93  =========================================
94  Feature requests, bug reports and patches
95  =========================================
97  Feature requests, bug report and patches should all be filed in our
98  Bugzilla at http://bugs.gpodder.org - for general discussion and questions,
99  please send a message to gpodder-devel (this is a subscriber-only list, so
100  you have to subscribe first before sending mail there).
102  For up to date information about gPodder, see the website and Wiki.
104    Homepage:       http://www.gpodder.org/
105    Wiki:           http://wiki.gpodder.org/
106    Bugzilla:       http://bugs.gpodder.org/
108    FAQs:           http://wiki.gpodder.org/wiki/FAQs
109    Mailing List:   gpodder-devel@berlios.de
110    IRC Channel:    #gpodder on FreeNode (irc.freenode.net)
112  Have fun with gPodder!
113  Thomas Perl <thpinfo.com>