|author||Matthias P. Braendli <email@example.com>||2019-10-28 11:29:36 +0100|
|committer||GitHub <firstname.lastname@example.org>||2019-10-28 11:29:36 +0100|
Merge pull request #38 from andimik/next
Updated Readme and Install for better online reading
|-rw-r--r--||INSTALL.md (renamed from INSTALL)||87|
2 files changed, 63 insertions, 44 deletions
@@ -1,12 +1,12 @@
- * A C++11 capable compiler
- * pkg-config
- * FFTW 3.x
- * Optional UHD for USRP
- * Optional SoapySDR (see below)
- * Optional ZeroMQ http://www.zeromq.org
+* A C++11 capable compiler
+* FFTW 3.x
+* Optional UHD for USRP
+* Optional SoapySDR (see below)
+* Optional ZeroMQ http://www.zeromq.org
Simple install procedure:
@@ -21,20 +21,34 @@ Simple install procedure:
-The configure script can be launch with a variety of options:
- --disable-zeromq Disable ZeroMQ input (to be used with ODR-DabMux),
- output and remotecontrol.
- --disable-output-uhd Disable the binding to the UHD driver for USRPs
- --enable-fast-math Compile using the -ffast-math option that gives a substantial
- speedup at the cost of floating point correctness.
- --disable-native Do not compile ODR-DabMod with -march=native compiler option.
- This is meant for distribution package maintainers who want to
- use their own march option, and for people running into compilation
- issues due to -march=native. (e.g. GCC bug 70132 on ARM systems)
+The configure script can be launched with a variety of options:
-Debugging options: You should not enable any debug option if you need good performance.
- --enable-trace Create debugging files for each DSP block for data analysis
+Disable ZeroMQ input (to be used with ODR-DabMux), output and remotecontrol.
+Disable the binding to the UHD driver for USRPs
+Compile using the `-ffast-math` option that gives a substantial speedup at the cost of floating point correctness.
+**Remark:** Do not compile ODR-DabMod with `-march=native` compiler option. This is meant for distribution package maintainers who want to use their own march option, and for people running into compilation issues due to `-march=native`. (e.g. GCC bug 70132 on ARM systems)
+**Debugging options:** You should not enable any debug option if you need good performance.
+Create debugging files for each DSP block for data analysis
For more information, call:
@@ -42,16 +56,16 @@ For more information, call:
-While the performance of modern systems is in most cases good enough to
+While the performance of modern systems is good enough in most cases to
run ODR-DabMod, it is sometimes necessary to increase the compilation
optimisation if all features are used or on slow systems.
Tricks for best performance:
- * Do not use --disable-native
- * Use --enable-fast-math
- * Add -O3 to compiler flags
- * Disable assertions with -DNDEBUG
+* Do not use `--disable-native`
+* Use `--enable-fast-math`
+* Add `-O3` to compiler flags
+* Disable assertions with `-DNDEBUG`
Applying all together:
@@ -70,27 +84,32 @@ measurable overhead. Please report if you get warnings or errors when using the
Nearly as simple install procedure using repository:
- * Download and install dependencies as above
- * Clone the git repository
- * Bootstrap autotools:
- % ./bootstrap.sh
- In case this fails, try:
- % aclocal && automake --gnu --add-missing && autoconf
- * Then use ./configure as above
+* Download and install dependencies as above
+* Clone the git repository
+* Bootstrap autotools:
+ % ./bootstrap.sh
+ In case this fails, try:
+ % aclocal && automake --gnu --add-missing && autoconf
+* Then use `./configure` as above
SoapySDR support and required dependencies
SoapySDR is a vendor-neutral library to drive SDR devices. It can be used to
drive the HackRF and the LimeSDR among others.
Required dependencies that need to be installed are, in order:
1. SoapySDR itself from https://github.com/pothosware/SoapySDR
-1. The LimeSuite for the LimeSDR from https://github.com/myriadrf/LimeSuite
-1. HackRF support for SoapySDR from https://github.com/pothosware/SoapyHackRF
+2. The LimeSuite for the LimeSDR from https://github.com/myriadrf/LimeSuite
+3. HackRF support for SoapySDR from https://github.com/pothosware/SoapyHackRF
ODR-DabMod will automatically recognise if the SoapySDR library is installed on
-your system, and will print at the end of ./configure if support is enabled or
+your system, and will print at the end of `./configure` if support is enabled or
-A configuration example is available in doc/example.ini
+A configuration example is available in `doc/example.ini`
@@ -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
-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.
-See the INSTALL file for installation instructions.
+See the `INSTALL.md` file for installation instructions.
-See the files LICENCE and COPYING
+See the files `LICENCE` and `COPYING`