From 2e325d2c2a34ecda37636e67969ee1550e78fbba Mon Sep 17 00:00:00 2001 From: "Matthias P. Braendli" Date: Sun, 30 Mar 2014 10:38:02 +0200 Subject: Markdownise README and INSTALL --- INSTALL | 65 ----------------------------------------------------- INSTALL.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Makefile.am | 5 ++++- README | 44 ------------------------------------ README.md | 52 +++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 130 insertions(+), 110 deletions(-) delete mode 100644 INSTALL create mode 100644 INSTALL.md delete mode 100644 README create mode 100644 README.md diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 6b03944..0000000 --- a/INSTALL +++ /dev/null @@ -1,65 +0,0 @@ -Required dependencies: -====================== - - * libfec from Phil Karn, with compatibility patch: - https://github.com/Opendigitalradio/ka9q-fec - * Boost 1.48 or later - * Optional ZeroMQ 4 from http://www.zeromq.org - Use --disable-output-zeromq if you don't have it - -Simple install procedure using tarball release: -=============================================== - - % git clone https://github.com/Opendigitalradio/ka9q-fec.git - % cd ka9q-fec - % ./configure # Run the configure script - % make # Build the library - [as root] - % make install # Install the library - - # install zeromq 4.0.3 - % wget http://download.zeromq.org/zeromq-4.0.3.tar.gz - % tar -f zeromq-4.0.3.tar.gz -x - % cd zeromq-4.0.3 - % ./configure - % make - [as root] - % make install - - % tar xjf odr-dabmux-x.y.z.tar.bz2 # Unpack the source - % cd odr-dabmux-x.y.z # Change to the source directory - % ./configure --enable-input-zeromq --enable-output-zeromq - # Run the configure script - % make # Build ODR-DabMux - [ as root ] - % make install # Install ODR-DabMux - -Nearly as simple install procedure using repository: -==================================================== - -The code in the repository is more recent than the latest -release and could be less stable, but already have new -features. - - * Download and install fec as above - * Clone the git repository - * Bootstrap autotools: - % ./bootstrap.sh - * Then use ./configure as above - - -Advanced install procedure: -=========================== - -The configure script can be launch with a variety of options, launch the -following command for a complete list: - % ./configure --help - -Notes about libfec -================== -The original libfec version from - http://www.ka9q.net/code/fec/fec-3.0.1.tar.bz2 -does not compile on x86_64 nor on ARM. That is the reason why the patched -version is suggested. - -On x86 systems, the original version can also be used. diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..7e0f59b --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,74 @@ +Required dependencies: +====================== + +* libfec from Phil Karn, with compatibility patch: +[ka9q-fec](https://github.com/Opendigitalradio/ka9q-fec) +* Boost 1.48 or later +* Optional ZeroMQ 4 from [http://www.zeromq.org](http://www.zeromq.org) + +Use the --disable-output-zeromq ./configure option if you don't have ZeroMQ. + +Simple install procedure using tarball release: +=============================================== + +Install libfec +-------------- + + % git clone https://github.com/Opendigitalradio/ka9q-fec.git + % cd ka9q-fec + % ./configure # Run the configure script + % make # Build the library + [as root] + % make install # Install the library + +Install zeromq 4.0.3 +-------------------- + + % wget http://download.zeromq.org/zeromq-4.0.3.tar.gz + % tar -f zeromq-4.0.3.tar.gz -x + % cd zeromq-4.0.3 + % ./configure + % make + [as root] + % make install + +Install odr-dabmux +------------------ + + % tar xjf odr-dabmux-x.y.z.tar.bz2 # Unpack the source + % cd odr-dabmux-x.y.z # Change to the source directory + % ./configure --enable-input-zeromq --enable-output-zeromq + # Run the configure script + % make # Build ODR-DabMux + [ as root ] + % make install # Install ODR-DabMux + +Nearly as simple install procedure using repository: +==================================================== + +The code in the repository is more recent than the latest +release and could be less stable, but already have new +features. + +* Download and install fec as above +* Clone the git repository +* Bootstrap autotools: 
% ./bootstrap.sh
+* Then use ./configure as above + + +Advanced install procedure: +=========================== + +The configure script can be launch with a variety of options, launch the +following command for a complete list: + + % ./configure --help + +Notes about libfec +================== +The original libfec version from +[ka9q.net](http://www.ka9q.net/code/fec/fec-3.0.1.tar.bz2) +does not compile on x86\_64 nor on ARM. That is the reason why the patched +version is suggested. + +On x86 systems, the original version can also be used. diff --git a/Makefile.am b/Makefile.am index 6e9e392..b1578f9 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,5 +1,8 @@ # Copyright (C) 2008, 2009 Her Majesty the Queen in Right of Canada # (Communications Research Center Canada) +# +# Copyright (C) 2014 Matthias P. Braendli +# http://opendigitalradio.org # This file is part of ODR-DabMux. # @@ -20,5 +23,5 @@ SUBDIRS =src lib ACLOCAL_AMFLAGS = -I m4 -EXTRA_DIST =COPYING NEWS README AUTHORS ChangeLog TODO doc +EXTRA_DIST =COPYING NEWS README.md INSTALL.md LICENCE AUTHORS ChangeLog TODO doc diff --git a/README b/README deleted file mode 100644 index acdd124..0000000 --- a/README +++ /dev/null @@ -1,44 +0,0 @@ -OVERVIEW -======== -ODR-DabMux is a fork of CRC-DabMux, which was developed by the Communications -Research Center Canada. It has been forked by the Opendigitalradio project. - -ODR-DabMux is a DAB (Digital Audio Broadcasting) multiplexer compliant to -ETSI EN 300 401. - -In addition to the features of CRC-DabMux, this fork contains: -- configuration file support, see doc/example.mux -- timestamping support required for SFN -- a ZeroMQ ETI output that can be used with ODR-DABMOD -- a ZeroMQ dabplus input that can be used with fdk-aac-dabplus-zmq - and toolame-dab -- supports logging to syslog -- supports ZMQ input monitoring with munin tool -- supports a Telnet Remote Control for setting/getting parameters - (can change subchannel and component labels, and ZMQ input buffer - parameters) - -The src/ directory contains the source code of ODR-DabMux. - -The doc/ directory contains the ODR-DabMux documentation, and an example -configuration file. - -The lib/ directory contains source code of libraries needed to build -ODR-DabMux. - -INSTALL -======= -See the INSTALL file for installation instructions. - -LICENCE -======= -See the files LICENCE and COPYING - -CONTACT -======= -Matthias P. Braendli -Pascal Charest - -http://opendigitalradio.org/ -http://mmbtools.crc.ca/ -http://mpb.li/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a2deef --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +Overview +======== + +*ODR-DabMux* is a fork of CRC-DabMux, which was developed by the Communications +Research Center Canada. It has been forked by the +[Opendigitalradio project](http://opendigitalradio.org). + +ODR-DabMux is a *DAB (Digital Audio Broadcasting) multiplexer* compliant to +ETSI EN 300 401. + +In addition to the features of CRC-DabMux, this fork contains: + +- configuration file support, see doc/example.mux +- timestamping support required for SFN +- a ZeroMQ ETI output that can be used with ODR-DabMod +- a ZeroMQ dabplus input that can be used with fdk-aac-dabplus + and toolame-dab +- supports logging to syslog +- supports ZMQ input monitoring with munin tool +- includes a Telnet Remote Control for setting/getting parameters + (can change subchannel and component labels, and ZMQ input buffer + parameters) + +The src/ directory contains the source code of ODR-DabMux. + +The doc/ directory contains the ODR-DabMux documentation, and an example +configuration file. + +The lib/ directory contains source code of libraries needed to build +ODR-DabMux. + +Install +======= + +See the INSTALL.md file for installation instructions. + +Licence +======= + +See the files LICENCE and COPYING + +Contact +======= + +Matthias P. Braendli *matthias [at] mpb [dot] li* + +Pascal Charest *pascal [dot] charest [at] crc [dot] ca* + +- http://opendigitalradio.org/ +- http://mmbtools.crc.ca/ +- http://mpb.li/ + -- cgit v1.2.3