From 6c842ed65a23fb7985bbd38acdeffc2b4b409e71 Mon Sep 17 00:00:00 2001 From: ha7ilm Date: Sun, 2 Apr 2017 12:54:58 +0200 Subject: [PATCH] Docs --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 87e2d53..39d037d 100644 --- a/README.md +++ b/README.md @@ -484,13 +484,21 @@ When running complicated `csdr` commands, we usually run into using `python` to This function can eliminate some typing and make our command clearer. -Instead of having to write: `csdr shift_addition_cc $(python -c "print 1200/2400000.")` +Instead of having to write: -...we can type: `csdr shift_addition_cc $(csdr =1200/2400000.)` + csdr shift_addition_cc $(python -c "print 1200/2400000.") -If using parenthesis inside the expression, it needs to be escaped (as `bash` would want to parse it): `csdr shift_addition_cc $(csdr =\(1200+300\)/2400000)` +...we can type: -Another solution is using single quotes to wrap the expression: `csdr shift_addition_cc $(csdr '=(1200+300)/2400000.')` + csdr shift_addition_cc $(csdr =1200/2400000.) + +If using parenthesis inside the expression, it needs to be escaped (as `bash` would want to parse it): + + csdr shift_addition_cc $(csdr =\(1200+300\)/2400000) + +Another solution is using single quotes to wrap the expression: + + csdr shift_addition_cc $(csdr '=(1200+300)/2400000.') #### Buffer sizes @@ -546,7 +554,7 @@ Example of initialization if the process always works with a fixed output size, `csdr` was tested with GNU Radio Companion flowgraphs. These flowgraphs are available under the directory `grc_tests`, and they require the gr-ha5kfu set of blocks for GNU Radio. -## [sdr.js] (#sdrjs) +## [sdr.js](#sdrjs) *sdr.js* is *libcsdr* compiled to JavaScript code with *Emscripten*. Nowadays JavaScript runs quite fast in browsers, as all major browser vendors included JavaScript JIT machines into their product. You can find a great introductory slideshow here on the concept behind *Emscripten* and *asm.js*. @@ -568,7 +576,7 @@ To remove *sdr.js* and the compiled dependencies: make emcc-clean -## [nmux] (#nmux) +## [nmux](#nmux) The repo also contains a command line tool called `nmux`, which is a TCP stream multiplexer. It reads data from the standard input, and sends it to each client connected through TCP sockets. Available command line options are: * `--port (-p), --address (-a):` TCP port and address to listen. @@ -577,7 +585,7 @@ The repo also contains a command line tool called `nmux`, which is a TCP stream `nmux` was originally written for use in OpenWebRX. -## [Licensing] (#licensing) +## [Licensing](#licensing) Most of the code of `libcsdr` is under BSD license. However, before the implementation of some algoritms, GPL-licensed code from other applications have been reviewed.