Commit e7f27072 authored by Marvin Scholz's avatar Marvin Scholz

Updated README, renamed it so that it is parsed as markdown

parent 341374a6
icecast 2.x - README
Icecast 2 - README
---------------------------------------------------------------------
Icecast is a streaming media server which currently supports Ogg
streaming including the vorbis and theora codecs. Also icecast can
handle other streams like MP3/AAC/NSV.
streaming including the Vorbis and Theora codecs. Also Icecast can
handle other streams like MP3/AAC/NSV, but this is not officially
supported.
It can be used to create an Internet radio station or a privately
running jukebox and many things in between. It is very versatile in
that new formats can be added relatively easily and supports open
......@@ -14,15 +16,16 @@ license is included with this software in the COPYING file.
Prerequisites
---------------------------------------------------------------------
icecast requires the following packages :
Icecast requires the following packages:
- [libxml2][1]
- [libxslt][2]
- [curl][3] (>= version 7.10 required)
- [ogg/vorbis][4] (>= version 1.0 required)
* libxml2 - http://xmlsoft.org/downloads.html
* libxslt - http://xmlsoft.org/XSLT/downloads.html
* curl - http://curl.haxx.se/download.html (>= version 7.10 required)
NOTE: icecast may be compiled without curl, however this will
disable Stream Directory server interaction (YP) and URL based
authentication.
* ogg/vorbis - http://www.vorbis.com/files (>= version 1.0 required)
__NOTE__: Icecast may be compiled without curl, however this will
disable Stream Directory server interaction (YP) and URL based
authentication.
A note about prerequisite packages
---------------------------------------------------------------------
......@@ -30,28 +33,36 @@ Most distributions have some sort of package management repository for
pre-built packages (eg rpm, deb etc). These setups often have a runtime
package, which is usually installed for you by default, and enables you
to run applications that depend on them. However if you are building
icecast from source then the runtime system is not enough. You will also
Icecast from source then the runtime system is not enough. You will also
need a development package named something like libxslt-devel
Build/Install
---------------------------------------------------------------------
To build icecast on a Unix platform, perform the following :
To build Icecast on a Unix platform, perform the following:
Run
./configure
make
make install
./configure
make
make install
This is the typical procedure if you download the tar file. If you retrive
the code from subversion or want to rebuild the configure then run autogen.sh
the code from Git or want to rebuild the configure then run the `autogen.sh`
instead of the configure above. Most people do not need to run autogen.sh
A sample config file will be placed in /usr/local/etc (on UNIX) or in
the current working directory (on Win32) and is called icecast.xml
A sample config file will be placed in `/usr/local/etc` (on UNIX) or in
the current working directory (on Win32) and is called `icecast.xml`
Documentation for icecast is available in the doc directory, by
viewing doc/index.html in a browser.
Documentation for Icecast is available in the doc directory, by
viewing `doc/index.html` in a browser.
Online documentation can be found on [Icecasts Website][5].
Please email us at icecast@xiph.org or icecast-dev@xiph.org, or come and see
us at irc.freenode.net, channel #icecast, if you have any troubles.
us at irc.freenode.net, channel [#icecast][6], if you have any troubles.
[1]: http://xmlsoft.org/downloads.html
[2]: http://xmlsoft.org/XSLT/downloads.html
[3]: http://curl.haxx.se/download.html
[4]: http://www.vorbis.com/files
[5]: http://icecast.org/docs/
[6]: https://webchat.freenode.net/?channels=#icecast
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment