Handle 304 (Not Modified) during feed update.
[gpodder.git] / README
blob18903e53f2e615e5be050214474b33a4ae5a046f
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
37    * python-pysqlite2 (already included in Python 2.5, but needed for 2.4)
39  Additional dependencies for iPod synchronization support:
41    * One of the following metadata libraries:
42      - python-pymad (preferred; MAD MP3 decoder Python bindings)
43      - python-eyed3 (alternative to pymad; eyeD3 Python bindings)
44    * python-gpod (libgpod's Python bindings)
45    * mplayer (OPTIONAL; if you want video podcast length detection)
47  Additional dependencies for MTP-based device synchronization support:
49    * python-pymtp (libmtp's Python bindings; nick125.com/projects/pymtp)
51  Additional dependencies for "Update tags after download":
53    * python-eyed3 (for updating MP3 files)
54    * vorbis-tools (for updating OGG files)
56  Additional dependencies for converting OGGs to MP3s on iPod sync:
58    * oggdec (for decoding OGG files)
59    * lame (for encoding MP3 files)
61  Additional dependencies if you want direct BitTorrent download support:
63    * gnome-btdownload
65  Additional dependencies if you want Bluetooth file send support:
67    * python-bluez OR hcitool (for detecting nearby devices)
68    * gnome-obex-send OR bluetooth-sendto (for the file send operation)
70  Additional dependencies if you want Rockbox Cover Art syncing:
72    * python-imaging (Python Imaging Library, PIL)
74  Additional dependencies if you want to install from source:
76    * help2man
77    * python-dev
78    * intltool
79    * imagemagick
81  ============
82  Installation
83  ============
85  Extract the tar archive somewhere into your home directory and cd into 
86  the directory where you extracted it, for example:
88    tar xzvf gpodder-0.13.0.tar.gz
89    cd gpodder-0.13.0/
90    make install
92  If you have any problems, please visit the gPodder website or mail the 
93  gPodder mailing list (see below for more information).
95  =========================================
96  Feature requests, bug reports and patches
97  =========================================
99  Feature requests, bug report and patches should all be filed in our
100  Bugzilla at http://bugs.gpodder.org - for general discussion and questions,
101  please send a message to gpodder-devel (this is a subscriber-only list, so
102  you have to subscribe first before sending mail there).
104  For up to date information about gPodder, see the website and Wiki.
106    Homepage:       http://www.gpodder.org/
107    Wiki:           http://wiki.gpodder.org/
108    Bugzilla:       http://bugs.gpodder.org/
110    FAQs:           http://wiki.gpodder.org/wiki/FAQs
111    Mailing List:   gpodder-devel@berlios.de
112    IRC Channel:    #gpodder on FreeNode (irc.freenode.net)
114  Have fun with gPodder!
115  Thomas Perl <thpinfo.com>