1
2
 Amarok - the audio player for KDE
3
===================================
4
5
There are many media players around these days, true. What's missing from most
6
players is a user interface that doesn't get in the way of the user. How many
7
buttons do you have to press for simply adding some new tracks to the playlist?
8
Amarok tries to be a little different, providing a simple drag and drop
9
interface that really makes playlist handling easy.
10
11
12
 FEATURES
13
==========
14
15
    * Quick and simple drag and drop playlist creation
16
    * Music library
17
    * Cross platform. Support for Unix, MacOS X and Windows.
18
    * Plays all audio formats known to man
19
    * Cover art download using Amazon services
20
    * Automatic play-statistics generation (iRate style)
21
    * Full lyrics download
22
    * Learn about your music with integrated Wikipedia
23
    * Full Last.fm support
24
    * Fully configurable on screen display for track changes
25
    * Podcast support
26
    * iPod support
27
    * Powerful scripting interface
28
    * KDE integration
29
    * Integration with multiple web sources, Magnatune, Jamendo, Ampache and Mp3tunes 
30
      among others.
31
--------------------------------------------------------------------------------
32
33
34
 DEPENDENCIES
35
==============
36
37
Required
38
    * KDE-Libs 4.1 + KDE-Base-runtime 4.1 (or newer)
39
      http://www.kde.org
40
41
    * TagLib 1.5 (or newer)
42
      (Metadata tagging library)
43
      http://freshmeat.net/projects/taglib
44
45
    * MySQL 5.0 (possibly 5.1.26rc) Embedded: libmysqld compiled with fPIC
46
      (In-process database support)
47
48
Optional
49
    * libgpod 0.4.2 (or newer)
50
      (iPod support)
51
      http://www.gtkpod.org/libgpod.html
52
53
    * libmp4v2 (mpeg4ip 1.5 is recommended, faad2 is less reliable)
54
      (MP4/AAC tag reading & writing)
55
      http://www.sf.net/projects/mpeg4ip
56
      http://www.audiocoding.com
57
58
    * Mp3tunes.com integration (including syncronization) requires:
59
      * OpenSSL http://www.openssl.org
60
      * libxml2 http://xmlsoft.org
61
      * libcurl http://curl.haxx.se
62
      * Glib2 http://www.gtk.org
63
      * Loudmouth, the Jabber library, http://www.loudmouth-project.org/
64
      * Qt must be compiled with Glib enabled
65
66
67
Please note, if compiling from source you must also install the devel versions
68
of these packages.
69
--------------------------------------------------------------------------------
70
71
72
 IMPORTANT INSTALL INSTRUCTIONS
73
================================
74
75
To compile from source, please refer to the INSTALL file.
76
77
Packages for popular distributions are available at http://amarok.kde.org
78
--------------------------------------------------------------------------------
79
80
81
 FURTHER RESOURCES
82
===================
83
84
For answers to problems like "Amarok won't play any MP3s!" and "My MP3s skip
85
and stutter!" please visit:
86
87
   http://amarok.kde.org/
88
--------------------------------------------------------------------------------
89
90
91
 INFORMATION FOR PACKAGERS
92
===========================
93
94
It is possible to build Amarok to use MySQL as the database backend. Using
95
MySQL makes the Amarok collection faster.
96
97
In order to limit the dependencies the Amarok package demands we suggest
98
splitting Amarok into the following packages:
99
100
   1. Amarok + Phonon Engine
101
   2. iPod media device
102
   3. MTP media device
103
104
Amarok is modular and will be fully functional as long as one of 2 or 3 is
105
also installed. Hence we suggest Amarok + one backend.
106
107
If you make packages for Amarok please let us know and we'll link to you on the
108
homepage (as long as you don't object).
109
--------------------------------------------------------------------------------
110
111
112
 CONTRIBUTING
113
==============
114
115
If you wish to contribute to Amarok, you should build it from SVN and subscribe
116
to the amarok AT kde.org mailing list. The IRC channel is also a place where
117
it's  nice  to  be, since you can talk to other developers much easier, and
118
get instant notification of commits to the SVN. For instant email notification
119
of commits, visit http://commitfilter.kde.org/ and http://amarok.be/fisheye
120
provides a slightly-less-instant overview.
121
122
More info at:
123
http://amarok.kde.org/wiki/Development/Join
124
125
See you in IRC!
126
127
--------------------------------------------------------------------------------
128
129
WWW:  http://amarok.kde.org
130
MAIL: amarok@kde.org
131
IRC:  irc.freenode.net - #amarok, #amarok.de, #amarok.es, #amarok.fr