diff options
Diffstat (limited to 'README.md')
| -rwxr-xr-x | README.md | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100755 index 00000000..6d40e20d --- /dev/null +++ b/README.md @@ -0,0 +1,125 @@ +Ampache +======= + +Basics +------ + +Ampache is a web based audio/video streaming application and file +manager allowing you to access your music & videos from anywhere, +using almost any internet enabled device. + +Ampache's usefulness is heavily dependent on being able to extract +correct metadata from embedded tags in your files and/or the filename. +Ampache is not a media organiser; it is meant to be a tool which +presents an already organised collection in a useful way. It assumes +that you know best how to manage your files and are capable of +choosing a suitable method for doing so. + +Translations +------------ + +Ampache is currently translated (at least partially) into the +following languages. If you are interested in updating an existing +translation or adding a new one please 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) + +Credits +------- + +Thanks to all those who have helped make Ampache awesome: + +* Scott Kveton: Original creator of Ampache, 2001 - 2003 +* Robert Hopson +* Andy Morgan +* RosenSama +* latka +* Lamar Hansford +* Lacy Morrow +* Karl Vollmer (vollmerk) +* Paul Arthur MacIain (flowerysong) +* Chris Slamar (cslamar) +* Holger Brunn +* Kevin Purdy (purdyk) +* Charlie Smotherman (porthose) + +Requirements +------------ + +A web server. All of the following have been used, though Apache +receives the most testing: + +* Apache +* lighttpd +* nginx +* IIS + +PHP 5.3 or greater. + +Required PHP modules: + +* PDO +* PDO_MYSQL +* hash +* session +* json + +MySQL 5.x + +Installation +------------ + +Please see docs/INSTALL + +Upgrading +--------- + +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 into config/. All +database updates will be handled by Ampache. + +License +------- + +Ampache is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License v2 +as published by the Free Software Foundation. + +Ampache includes some external modules that carry their own licensing. + +* [getID3()](http://getid3.sourceforge.net/): GPL v2 +* [Horde_Browser](http://www.horde.org/): LGPL v2.1 +* [PHP-gettext](https://launchpad.net/php-gettext): GPL v2 +* php_musicbrainz: LGPL v2.1 +* PHP MPD interface: GPL v2 +* [PHPMailer](http://phpmailer.codeworxtech.com/): LGPL v2.1 +* [Prototype](http://www.prototypejs.org/): MIT +* [Snoopy](http://snoopy.sourceforge.net/): LGPL v2.1 +* validateEmail.php: "free for any use" +* [Whatever:hover](http://www.xs4all.nl/~peterned): LGPL v2.1 + +Contact Us +---------- + +Hate it? Love it? Let us know. Also let us know if you think of any +more features, encounter bugs, etc. + +* [Public Repository](http://github.com/ampache) +* IRC: chat.freenode.net #ampache +* [Issue Tracker](https://github.com/ampache/ampache/issues) +* [Documentation](https://github.com/ampache/ampache/wiki) + |