path: root/README.md
diff options
authorMatthias P. Braendli <matthias.braendli@mpb.li>2014-03-30 10:38:02 +0200
committerMatthias P. Braendli <matthias.braendli@mpb.li>2014-03-30 10:38:02 +0200
commit2e325d2c2a34ecda37636e67969ee1550e78fbba (patch)
treede273c4184b78f16cc9a2853f6f608293cd5cbd6 /README.md
parent77b7ee920e74d73178254a8f6d0954df6bd57ee9 (diff)
Markdownise README and INSTALL
Diffstat (limited to 'README.md')
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8a2deef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+*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
+See the INSTALL.md file for installation instructions.
+See the files LICENCE and COPYING
+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/