aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2020-05-06 15:24:31 +0200
committerMatthias P. Braendli <matthias.braendli@mpb.li>2020-05-06 15:24:31 +0200
commitd633c266b24f4eada1ed0cf8821b572980ae1b2f (patch)
tree5960af8497f293b828be2223297a440ab4b307c7
parent36aa7c9d39602ae842ccfc49aaee3ba8f5631b2d (diff)
downloadODR-EDI2EDI-d633c266b24f4eada1ed0cf8821b572980ae1b2f.tar.gz
ODR-EDI2EDI-d633c266b24f4eada1ed0cf8821b572980ae1b2f.tar.bz2
ODR-EDI2EDI-d633c266b24f4eada1ed0cf8821b572980ae1b2f.zip
Update README and add LICENCE
-rw-r--r--LICENCE34
-rw-r--r--README.md46
2 files changed, 68 insertions, 12 deletions
diff --git a/LICENCE b/LICENCE
new file mode 100644
index 0000000..d070599
--- /dev/null
+++ b/LICENCE
@@ -0,0 +1,34 @@
+LICENSING
+=========
+Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Her Majesty
+the Queen in Right of Canada (Communications Research Center Canada)
+
+Copyright (C) 2020
+Matthias P. Braendli, http://www.opendigitalradio.org
+
+This file is part of the ODR-mmbTools.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+
+KA9Q FEC routines
+-----------------
+
+lib/fec/ contains code from KA9Q's fec library. Please see
+lib/fec/README.md and src/fec/LICENSING
+
+Other parts
+-----------
+
+lib/edi/PFT.{hpp,cpp} are APACHE 2.0 licensed.
diff --git a/README.md b/README.md
index 57bdaed..2e51b5c 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,47 @@
-ODR-EDI2EDI
-===========
+Overview
+========
-Sometimes you want to carry EDI over the Internet to a device that doesn't
-support EDI/TCP. Carrying EDI/UDP over the Internet will not work because of
-burst packet loss, and EDI resend is not implemented.
+ODR-EDI2EDI is part of the ODR-mmbTools tool set. More information about the
+ODR-mmbTools is available in the *guide*, available on the
+[Opendigitalradio mmbTools page](http://www.opendigitalradio.org/mmbtools).
-With ODR-EDI2EDI, you can convert EDI/TCP to EDI/UDP on a small PC that is
-close to your device. It also allows you buffer the EDI and release it at a
-controlled point in time depending on the in-band timestamp.
+About ODR-EDI2EDI
+=================
+
+Sometimes you want to carry a DAB Ensemble using EDI over the Internet to a device that doesn't support EDI/TCP.
+Carrying EDI/UDP over the Internet will not work because of burst packet loss.
+
+With ODR-EDI2EDI, you can convert EDI/TCP to EDI/UDP on a small PC that is close to your device. It also allows you
+buffer the EDI and release it at a controlled point in time depending on the in-band timestamp.
+
+Every six seconds, a line with buffering time statistics is printed. If you use a process supervisor that writes this
+output to a logfile, you may use the *doc/stats_edi2edi_munin.py* script to analyse the logfile and present the
+statistics as [munin](http://munin-monitoring.org/) graphs.
You can also fan-out an EDI data stream to several destinations.
-This tool can be considered to be the successor of ODR-ZMQ2EDI which is
-distributed as a part of ODR-DabMux.
+This tool can be considered to be the successor of ODR-ZMQ2EDI which is distributed as a part of
+[ODR-DabMux](https://github.com/Opendigitalradio/ODR-DabMux).
Installation
-------------
+============
-Requirements: A C++11 compiler, autotools (debian: `build-essential automake libtool`)
+Requirements: A C++11 compiler, autotools (debian packets `build-essential automake libtool`)
./bootstrap.sh
./configure
make
sudo make install
+
+Licence
+=======
+
+See the files `LICENCE` and `COPYING`
+
+
+Contributions and Contact
+=========================
+
+Contributions to this tool are welcome, you can reach users and developers through the
+[CRC-mmbTools google group](https://groups.google.com/forum/#!forum/crc-mmbtools)
+or any other channels mentioned on the ODR website.