aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
blob: 95e6a429b377fd05556bcb56e076988f7c35d991 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
bbc-on-ice
==========

'bbc-on-ice' is a SHOUTcast (ICY protocol) bridge for BBC radio streams.
It adds metadata to the stream so that media players can display it.

Packages
--------
Regular releases are sporadic.  git master should be stable enough.  You can get
a package with the latest development version from Archlinux's AUR, or from
openSUSE Build Service for the rest of mainstream distributions.  Consult the
list of repositories and their respective links at:

https://build.opensuse.org/project/repositories/home:pjanouch:git

Building and Running
--------------------
Build dependencies: CMake, go

 $ git clone --recursive https://git.janouch.name/p/bbc-on-ice.git
 $ mkdir bbc-on-ice/build
 $ cd bbc-on-ice/build
 $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
 $ make

To install the application, you can do either the usual:

 # make install

Or you can try telling CMake to make a package for you.  For Debian it is:

 $ cpack -G DEB
 # dpkg -i bbc-on-ice-*.deb

Contributing and Support
------------------------
Use https://git.janouch.name/p/bbc-on-ice to report any bugs, request features,
or submit pull requests.  If you want to discuss this project, or maybe just
hang out with the developer, feel free to join me at irc://irc.janouch.name,
channel #dev.

License
-------
'bbc-on-ice' is written by Přemysl Janouch <p.janouch@gmail.com>.

You may use the software under the terms of the ISC license, the text of which
is included within the package, or, at your option, you may relicense the work
under the MIT or the Modified BSD License, as listed at the following site:

http://www.gnu.org/licenses/license-list.html