ampache/docs

-------------------------------------------------------------------------------
---------                    README - Ampache v.3.5                 -----------
-------------------------------------------------------------------------------

Contents:
 
 1. Intro
     a) Supported File-Types
     b) Supported Stream Methods
     c) Current Translations
     d) Special Thanks
 2. Getting all the components
 3. Setting Up
     a) Upgrading
 4. License
 5. Contact info

1. Intro:

  Ampache is a PHP-based interface to a MySQL database 
  where information about your audio files are stored.  The songs 
  are streamed using PHP; older versions required mod_mp3 but this
  version no longer does.  The songs are cataloged via PHP
  scripts.

  These tools are heavily dependent on quality tags in your audio
  files and or the file system organization. If you've kept them 
  up-to-date or organized this is the tool for you.  
  
  See CHANGELOG for version information.

  A) Supported File-Types

     Ampache currently supports the following audio file types. If
     you would like Ampache to support an additional file type please
     contact us on irc, or the forums and we will investigate adding 
     them. Thanks

	- MP3 (id3v1 && id3v2)
	- OGG
	- WMA/ASF
	- FLAC
	- RM
	- AAC/M4A/MP4
	- MPC
	- WV
	- SHN
	- APE
	- SPX
	- FLV
	- AVI
	- MPG
	- M4V
	- WMV

  B) Supported Stream Methods

     Ampache currently supports the following different methods for
     streaming your audio files. Please contact us if you would like
     to see additional methods. 

	- Single Stream 
		- extended m3u
		- simple m3u
		- standard pls
		- ASX
		- RAM
		- XSPF
	- Realtime Downsampling
	- Integrated Flash Player
	- Automatic Downsampling based on load
	- Local/Remote network definition based downsampling
	- On the Fly Transcoding (Requires additional applications)
	- Localplay
		- Music Player Daemon (MPD)
		- Winamp using (HTTPQ)
		- Shoutcast 
		- Icecast2
	- Democratic Vote based playback
	- 3rd Party clients using API (Amarok,Coherence,Quickplay)
	- 3rd Party Mobile clients using API (Android,Iphone,Blackberry,PalmOS)
	
  C) Current Translations

     Ampache is currently translated into the following languages. If
     you are interested in updating an existing translation or adding
     a new one please contact us at translation@ampache.org or see
     /locale/base/TRANSLATIONS for more instructions. 

	- English	(en_US)
	- German	(de_DE)
	- Spanish	(es_ES)
	- Dutch		(nl_NL)
	- Norwegian	(nb_NO)
	- UK English	(en_GB)
	- Italian	(it_IT)
	- French	(fr_FR)
	- Swedish	(sv_SE)
	- Japanese	(ja_JP) 
	- Catalan	(ca_ES)
	- Russian	(ru_RU)
        - Czech         (cs_CZ)

  D) A Special Thanks:
     Thanks to those who've helped us make Ampache so useable:
	 Scott Kveton - Original create of Ampache 2001 - 2003
	 Robert Hopson - Libglue, Playlists, Ogg support.. and much more
	 Andy Morgan - Sage / Voice of Reason
	 RosenSama - Previous Developer
         latka (from media.tangent.org site) for orphaned song ideas
	 Lamar Hansford (README/INSTALL improvements) & Upload
	 Lacy Morrow (Flash Player)

2. Getting all the components

  Apache >= 1.3.x http://www.apache.org OR other web server
  PHP >= 5.1.x http://www.php.net **
  	PHP5-Mysql
	PHP5-Session
	PHP5-gd (recommended)
	PHP5 ICONV 
	PHP5 ZLIB support (recommended)
  MySQL >= 5.x+ http://www.mysql.com

  ** PHP 5.3.x is required for Windows systems due to use of inet_pton
     and inet_aton functions.

3. Setting Up

  Please see the included INSTALL file or if possible the wiki
  for the most update to date instructions, http://ampache.org/wiki

3a. Upgrading Your Ampache Install

  If you are upgrading from an older version of Ampache we recommend
  moving the old directory out of the way, extracting the new copy in 
  its place and then copying the old config file. All database updates
  will be handled by the /update.php script. There is no need to insert
  the /sql/ampache.sql if you have an existing installation.

  Please see MIGRATION for specific instructions based on the version
 
4. License

  This Application falls under the Standard GPL v2. See Licence 
  included with this tar file. Credit for code is listed in the 
  changelog. 

5. Contact Info

  Hate it?  Love it?  Let us know.  Let us know if you think of any
    more features, bugs, etc.

  Public SVN: https://svn.ampache.org/
  IRC: irc.ampache.org #ampache (Freenode)
  Forums: http://ampache.org/forums
  Bugs: http://ampache.org/bugs
  Wiki: http://ampache.org/wiki
  Demo: http://ampache.org/demo

  -Karl Vollmer
  vollmer@ampache.org