aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2014-12-09 23:04:42 +0100
committerMatthias P. Braendli <matthias.braendli@mpb.li>2014-12-09 23:04:42 +0100
commit66eb4a62eb4c781f427e1938a7d42e2facf8194c (patch)
tree46a20ef4f8b83e7eddec494bff4de8e455c2eace /README.md
parente2d7cfa4ed5d8bfd4a4798b5f653d0bc222d5bce (diff)
downloaddabmod-66eb4a62eb4c781f427e1938a7d42e2facf8194c.tar.gz
dabmod-66eb4a62eb4c781f427e1938a7d42e2facf8194c.tar.bz2
dabmod-66eb4a62eb4c781f427e1938a7d42e2facf8194c.zip
Markdownise README
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8ea87c9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+OVERVIEW
+========
+ODR-DabMod is a fork of CRC-DabMod, which was developed by the Communications
+Research Center Canada. It has been forked by the Opendigitalradio project.
+
+ODR-DabMod is a DAB (Digital Audio Broadcasting) modulator compliant
+to ETSI EN 300 401.
+
+In addition to the features of CRC-DabMod, this fork contains:
+
+- Configuration file support, see doc/example.ini
+- Integrated UHD output for USRP devices
+ - Tested for B200, B100, USRP2, USRP1
+ - With WBX daughterboard (where appropriate)
+- Timestamping support required for SFN
+- A FIR filter (previously done in GNURadio by crc-dwap.py)
+- Improvements in logging (log to file, to syslog)
+- ETI sources: file (Raw, Framed and Streamed) and ZeroMQ
+- A Telnet remote-control that can be used to change some parameters during
+ runtime
+
+The src/ directory contains the source code of ODR-DabMod.
+
+The doc/ directory contains the ODR-DabMod documentation, and an example
+configuration file.
+
+The lib/ directory contains source code of libraries needed to build
+ODR-DabMod.
+
+INSTALL
+=======
+See the INSTALL 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/