rpitx/csdr
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Docs

Browse source
This commit is contained in:
ha7ilm 2017-04-02 12:54:58 +02:00
parent 790281e533
commit 6c842ed65a
1 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -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 <a href="https://github.com/simonyiszk/gr-ha5kfu">gr-ha5kfu</a> 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 <a href="https://kripken.github.io/mloc_emscripten_talk/cppcon.html">great introductory slideshow here</a> 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.