Conversion to the cmake building system based on S.Amelian's work.

The embedded sqlite3 has been upgraded to 3.4.2 .
Added few man pages taken from the Debian packaging system.
Rework of the README and INSTALL files.

Signed-off-by: gregory guy <[email protected]>
Signed-off-by: Slávek Banko <[email protected]>
(cherry picked from commit 16ec57d25f13f92bd0d84317f1679fef3b98eeaa)

1 files changed, 130 insertions, 1 deletions

diff --git a/INSTALL b/INSTALL
index 2e4b1228..d4ccdd90 100644
--- a/INSTALL
+++ b/INSTALL
@@ -13,7 +13,136 @@ base directory of the Amarok distribution:
 Note: --enable-final is not supported.
 
 
-The GNU installation instructions follow.
+ DEPENDENCIES
+==============
+
+Required
+    * tdelibs
+      http://trinitydesktop.org
+
+    * TagLib 1.4 (or newer)
+      (metadata tagging library)
+      http://freshmeat.net/projects/taglib
+
+    * Ruby 1.8
+      (programming language, used for scoring, lyrics, last.fm streams)
+      http://www.ruby-lang.org
+
+    * xine-lib 1.0.2 (or newer)
+      Note: xine-lib 1.1.1 is required for gapless playback.
+      (multimedia framework)
+      https://www.xine-project.org/home
+
+Optional
+
+    * tdebase
+      (needed for Konqueror Sidebar)
+      http://trinitydesktop.org
+
+    * MySQL 4 or 5
+      (faster database support)
+      http://www.mysql.com
+
+    * PostgreSQL 7.4
+      (faster database support)
+      http://www.postgresql.org
+
+    * OpenGL accelerated X-Server
+      (visualization rendering)
+
+    * Libvisual 0.4.0 + SDL 1.2
+      (visualization framework)
+      http://localhost.nl/~synap/libvisual/
+      http://www.libsdl.org
+
+    * ProjectM 0.96 (or newer)
+      (visualization plugins for Libvisual or XMMS)
+      http://xmms-projectm.sourceforge.net/
+
+    * libtunepimp 0.3 (or newer)
+      (automatic tagging support)
+      http://www.musicbrainz.org/
+
+    * K3B 0.11 (or newer)
+      (CD burning support)
+      http://www.k3b.org
+
+    * libgpod 0.4.2 (or newer)
+      (iPod support)
+      Note: libgpod 0.6.0 is required for the newest Apple iPods.
+      http://www.gtkpod.org/libgpod.html
+
+    * libifp 1.0.0.2
+      (iRiver iFP support)
+      http://ifp-driver.sourceforge.net/libifp/
+
+    * libmp4v2 (mpeg4ip 1.5 is recommended, faad2 is less reliable)
+      (MP4/AAC tag reading & writing)
+      http://www.sf.net/projects/mpeg4ip
+      http://www.audiocoding.com
+
+    * libnjb 2.2.4 (older versions may work)
+      (NJB mediadevice (Creative Nomad/Zen family, Dell DJ devices)
+      http://www.sf.net/projects/libnjb
+
+    * libmtp 0.1.1 (or newer)
+      (MTP media device support AKA PlaysForSure)
+      http://libmtp.sourceforge.net/
+
+    * libkarma 0.0.5 && OMFS 0.6.1
+      (Rio Karma support via USB)
+      http://freakysoft.de/html/libkarma/ && http://linux-karma.sf.net/
+
+
+
+ INSTALLATION-FAQ
+==================
+
+Q: Can I improve Amarok's startup time?
+A: Prelinking Amarok has spectacular results; however if you have binary openGL
+   drivers (eg Nvidia drivers), you will need to compile Amarok --without-opengl
+   in order to get the amarokapp binary to prelink (the amarok binary is not
+   important here).
+
+
+ INFORMATION FOR PACKAGERS
+===========================
+
+For Amarok packages we suggest you build:
+
+                % ./configure --disable-debug
+
+It is possible to build Amarok to use MySQL as the database backend. Using
+MySQL makes the Amarok collection faster.
+
+We suggest compiling Os, there is no particular part of Amarok that would
+benefit from optimisation, so the smallest binary is probably the best route.
+
+In order to limit the dependencies the Amarok package demands we suggest
+splitting Amarok into the following packages:
+
+   1. Amarok + one backend
+   2. xine-engine
+   3. Helix-engine
+   4. amarok_libvisual
+   5. ipod media device
+   6. ifp media device
+   7. njb media device
+   8. mtp media device
+   9. rio karma media device
+
+Amarok is modular and will be fully functional as long as one of 2 or 3 is
+also installed. Hence we suggest Amarok + one backend. Feel free to include the
+helix, MAS and NMM engines if you can satisfy their dependencies.
+
+Amarok ships with two binaries: amarok and amarokapp. The amarok binary is a
+wrapper designed to speed up command line argument passing. amarokapp is the
+real Amarok.
+
+If you make packages for Amarok please let us know and we'll link to you on the
+homepage (as long as you don't object).
+--------------------------------------------------------------------------------
+
 
 
 Basic Installation