summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2019-10-28 11:29:36 +0100
committerGitHub <noreply@github.com>2019-10-28 11:29:36 +0100
commitc635ebd15bc85914f644e8c7939e9983e9cd63fa (patch)
treed2421761abcf85ee02336f17faaaa69d659e11e7 /README.md
parent0aa6201a490bfabc0ae021ceb9f1fb0f46727c5d (diff)
parentaa000b091d7be2ea99c3b4353df07bdb8782110d (diff)
downloaddabmod-c635ebd15bc85914f644e8c7939e9983e9cd63fa.tar.gz
dabmod-c635ebd15bc85914f644e8c7939e9983e9cd63fa.tar.bz2
dabmod-c635ebd15bc85914f644e8c7939e9983e9cd63fa.zip
Merge pull request #38 from andimik/next
Updated Readme and Install for better online reading
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index 3721d94..90735de 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ Features
- Reads ETI and EDI, outputs compliant COFDM I/Q
- Supports native DAB sample rate and can also resample to other rates
- Supports all four DAB transmission modes
-- Configuration file support, see doc/example.ini
+- Configuration file support, see `doc/example.ini`
- Integrated UHD output for [USRP devices](https://www.ettus.com/product)
- Tested for B200, B100, USRP2, USRP1
- With WBX daughterboard (where appropriate)
@@ -31,31 +31,31 @@ Features
- ETI sources: ETI-over-TCP, file (Raw, Framed and Streamed) and ZeroMQ
- A Telnet and ZeroMQ remote-control that can be used to change
some parameters during runtime and retrieve statistics.
- See doc/README-RC.md for more information
+ See `doc/README-RC.md` for more information
- ZeroMQ PUB and REP output.
- Ongoing work about digital predistortion for PA linearisation.
- See python/dpd/README.md
-- A web GUI for control and supervision of modulator and predistortion engine. See python/gui/README.md
+ See `python/dpd/README.md`
+- A web GUI for control and supervision of modulator and predistortion engine. See `python/gui/README.md`
- A prototype algorithm for crest factor reduction.
-The src/ directory contains the source code of ODR-DabMod.
+The `src/` directory contains the source code of ODR-DabMod.
-The doc/ directory contains the ODR-DabMod documentation, an example
+The `doc/` directory contains the ODR-DabMod documentation, an example
configuration file and a script for munin integration.
-The lib/ directory contains source code of libraries needed to build
+The `lib/` directory contains source code of libraries needed to build
ODR-DabMod.
-The python/ directory contains a web-based graphical control interface and
+The `python/` directory contains a web-based graphical control interface and
the digital predistortion project.
INSTALL
=======
-See the INSTALL file for installation instructions.
+See the `INSTALL.md` file for installation instructions.
LICENCE
=======
-See the files LICENCE and COPYING
+See the files `LICENCE` and `COPYING`
CONTACT
=======