updted documentation

git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@1662 90c681e8-e032-0410-971d-27865f9a5e38

1 files changed, 59 insertions, 36 deletions

diff --git a/README b/README
index c6df9549a..80916f7f6 100644
--- a/README
+++ b/README
@@ -1,38 +1,54 @@
 Qmmp - Qt-based multimedia player
 
 This program is an audio-player, written with help of Qt library.
-
-Main opportunities:
-- Winamp and xmms skins support
-- plugins support
-- MPEG1 layer 1/2/3 support
-- Ogg Vorbis support
-- native FLAC support
-- Musepack support
-- WavePack support
-- ModPlug support
-- WMA support (and other formats provided by FFmpeg library)
-- PCM WAVE support (and other formats provided by libsndfile library)
-- AAC support
-- CD Audio support
-- CUE sheet support (experimental)
-- WavPack embedded CUE support (experimental)
-- FLAC embedded CUE support (experimental)
-- ALSA sound output
-- JACK sound output
-- OSS sound output
-- PulseAudio output
+Official home page: http://qmmp.ylsoftware.com/
+
+Supported formats: 
+- MPEG1 layer 2/3 
+- Ogg Vorbis
+- Native FLAC, Ogg FLAC
+- Musepack
+- WavePack
+- Tracker modules (mod, s3m, it, xm, etc)
+- ADTS AAC
+- CD Audio
+- WMA, Monkey's Audio (and other formats provided by FFmpeg library)
+- PCM WAVE (and other formats provided by libsndfile library)
+
+DSP effects:
+- BS2B effect
+- Sample rate converter
+- LADSPA effects
+
+Visual effects:
+- ProjectM visualization
+- Spectrum analyzer
+
+Output system support:
+- OSS
+- ALSA (Linux)
+- Pulse Audio
+- JACK
+- WaveOut (Win32)
+
+Other features:
+- Xmms and Winamp 2.x skins support
+- 10-band equalizer
+- MP3, Vorbis, AAC, AAC+ streams support
+- mms support (experimental)
+- MPRIS
+- Removable device detection (via HAL)
+- Video playback via Mplayer
+- Lyrics (using lyricsplugin.com)
+- Cover art support
+- CUE sheet support
+- Embedded CUE support (for FLAC and WavPack)
+- Multiple playlists
+- Automatic charset detection for cue files and ShoutCast metadata
+- Playlist formats: m3u, pls, xspf
+- ReplayGain support
 - Last.fm/Libre.fm scrobbler
-- Spectrum Analyzer
-- projectM visualization
-- sample rate conversion
-- bs2b dsp effect
-- streaming support (MP3, Vorbis via IceCast/ShoutCast)
-- removable device detection (via HAL)
-- MPRIS support
-- global hotkey support
-- video playback via Mplayer
-- lyrics support (using LyricWiki.org)
+- CDDB support
 
 Requirements:
 - OS GNU Linux
@@ -44,6 +60,7 @@ Requirements:
 - libalsa >= 1.0.1
 - taglib >= 1.6
 - curl >= 7.16
+- libmms >= 0.4 (Optional)
 - flac >= 1.1.3 (Optional)
 - libmpcdec >= 1.2.6 (Optional)
 - jackit >= 0.102.5 (Optional)
@@ -74,15 +91,21 @@ make
 Installation:
 make install
 
-If someone module (for example, Jack plugin) doesn't build or doesn't needed you can disable it
+If someone plugin (for example, Jack plugin) doesn't build or doesn't needed you can disable it
 by running:
 cmake ./ -DUSE_JACK:BOOL=FALSE
 
 Available options:
-USE_MAD, USE_FLAC, USE_VORBIS, USE_MPC, USE_MODPLUG, USE_SNDFILE, USE_WAVPACK, USE_FFMPEG, USE_AAC,
-USE_CUE, USE_MPLAYER, USE_CDA, USE_ALSA, USE_OSS, USE_JACK, USE_PULSE, USE_SRC, USE_BS2B, USE_ANALYZER, USE_MPRIS,
-USE_SCROBBLER, USE_STATICON, USE_NOTIFIER, USE_LYRICS, USE_HAL, USE_HOTKEY, USE_QMMP_DIALOG, USE_PROJECTM,
-USE_FILEOPS, USE_ENCA
+- USE_CURL, USE_MMS (transports);
+- USE_MAD, USE_FLAC, USE_VORBIS, USE_MPC, USE_MODPLUG, USE_SNDFILE, USE_WAVPACK, USE_FFMPEG, USE_AAC, USE_CUE,
+  USE_MPLAYER, USE_CDA (decoders);
+- USE_ALSA, USE_OSS, USE_JACK, USE_PULSE, USE_NULL, USE_WAVEOUT (output plugins);
+- USE_SRC, USE_BS2B, USE_LADSPA (effects);
+- USE_ANALYZER, USE_PROJECTM (visualization);
+- USE_MPRIS, USE_SCROBBLER, USE_STATICON, USE_NOTIFIER, USE_LYRICS, USE_HAL, USE_HOTKEY, USE_FILEOPS, USE_COVER,
+  USE_KDENOTIFY (general plugins);
+- USE_QMMP_DIALOG (file dialog);
+- USE_ENCA (automatic charset detection);
 
 Also you can use ccmake for changing plugins configuration.
 By default program will be installed in /usr/local. You can change default path by running: