aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2020-04-29 09:53:52 +0200
committerMatthias P. Braendli <matthias.braendli@mpb.li>2020-04-29 09:53:52 +0200
commita345b9f848750099a2631ee47babcc10035381c4 (patch)
tree65ef15be9a5bf5381596a793add0d67adea91581 /README.md
parent5849cc8696c96377506bd60337656481da6c21b4 (diff)
downloadODR-EDI2EDI-a345b9f848750099a2631ee47babcc10035381c4.tar.gz
ODR-EDI2EDI-a345b9f848750099a2631ee47babcc10035381c4.tar.bz2
ODR-EDI2EDI-a345b9f848750099a2631ee47babcc10035381c4.zip
Add README and start implementing main
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6f2f1ce..57bdaed 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
ODR-EDI2EDI
===========
+
+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.
+
+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.
+
+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.
+
+Installation
+------------
+
+Requirements: A C++11 compiler, autotools (debian: `build-essential automake libtool`)
+
+ ./bootstrap.sh
+ ./configure
+ make
+ sudo make install