aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 14 insertions, 19 deletions
diff --git a/README.md b/README.md
index 49ef277..90d6402 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-Overview
-========
+# Overview
ODR-DabMux is a *DAB (Digital Audio Broadcasting) multiplexer* compliant to
ETSI EN 300 401. It is the continuation of the work started by the
@@ -20,8 +19,6 @@ Features of ODR-DabMux:
- Includes a Telnet and ZMQ Remote Control for setting/getting parameters
- EDI input and output, both over UDP and TCP
- Support for FarSync TE1 and TE1e cards (G.703)
-- Something that will (with your help?) one day become a nice GUI for
- configuration, see `gui/README.md`
- Experimental STI-D(PI, X)/RTP input intended to be compatible
with compliant encoders.
- ZeroMQ and TCP ETI outputs that can be used with ODR-DabMod
@@ -30,11 +27,7 @@ Features of ODR-DabMux:
Additional tools:
-`odr-zmq2edi`, a tool that can convert a ZeroMQ ETI stream
-to an EDI stream.
-
-`odr-zmq2farsync`, a tool that can drive a FarSync card from
-a ZeroMQ ETI stream.
+`odr-zmq2farsync`, a tool that can drive a FarSync card from a ZeroMQ ETI stream.
The `src/` directory contains the source code of ODR-DabMux and the additional
tools.
@@ -45,18 +38,22 @@ configuration files, and the munin and xymon scripts for the statistics server.
The `lib/` directory contains source code of libraries needed to build
ODR-DabMux.
-Install
-=======
+Up to v4.5, this repository also contained
+`odr-zmq2edi`, a tool that can convert a ZeroMQ ETI stream to an EDI or ZMQ stream.
+This was superseded by `digris-zmq-converter` in the
+[digris-edi-zmq-bridge](https://github.com/digris/digris-edi-zmq-bridge) repository.
+
+## Install
-See `INSTALL.md` file for installation instructions.
+[Check the installation instructions.](INSTALL.md)
-Licence
-=======
+You may find [ODR-DabMux-GUI](https://github.com/Opendigitalradio/ODR-DabMux-GUI/) for configuring a DAB Ensemble.
+
+## Licence
See the files `LICENCE` and `COPYING`
-Contributions and Contact
-=========================
+## Contributions and Contact
Contributions to this tool are welcome, you can reach users and developers
through the
@@ -72,12 +69,10 @@ Matthias P. Braendli *matthias [at] mpb [dot] li*
Pascal Charest *pascal [dot] charest [at] crc [dot] ca*
-Acknowledgements
-================
+## Acknowledgements
David Lutton, Yoann Queret, Stefan Pöschel and Maik for bug-fix patches,
Wim Nelis for the Xymon monitoring scripts,
and many more for feedback and bug reports.
- [http://opendigitalradio.org/](http://opendigitalradio.org/)
-