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

Docs: even more formatting

Browse source
This commit is contained in:
ha7ilm 2017-04-02 13:04:05 +02:00
parent 4df9d52d67
commit d6bc505da8
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -147,6 +147,8 @@ You can use these commands on complex streams, too, as they are only interleaved
Regarding `csdr`, the first command-line parameter is the name of a function, others are the parameters for the given function. Compulsory parameters are noted as `<parameter>`, optional parameters are noted as `[parameter]`. Regarding `csdr`, the first command-line parameter is the name of a function, others are the parameters for the given function. Compulsory parameters are noted as `<parameter>`, optional parameters are noted as `[parameter]`.
Optional parameters have safe defaults, for more info look at the code. Optional parameters have safe defaults, for more info look at the code.
----
### [realpart_cf](#realpart_cf) ### [realpart_cf](#realpart_cf)
Syntax: Syntax:
@ -155,6 +157,8 @@ Syntax:
It takes the real part of the complex signal, and throws away the imaginary part. It takes the real part of the complex signal, and throws away the imaginary part.
----
### [clipdetect_ff](#clipdetect_ff) ### [clipdetect_ff](#clipdetect_ff)
Syntax: Syntax:
@ -163,6 +167,8 @@ Syntax:
It clones the signal (the input and the output is the same), but it prints a warning on `stderr` if any sample value is out of the -1.0 ... 1.0 range. It clones the signal (the input and the output is the same), but it prints a warning on `stderr` if any sample value is out of the -1.0 ... 1.0 range.
----
### [limit_ff](#limit_ff) ### [limit_ff](#limit_ff)
Syntax: Syntax:
@ -171,6 +177,8 @@ Syntax:
The input signal amplitude will not be let out of the `-max_amplitude ... max_amplitude` range. The input signal amplitude will not be let out of the `-max_amplitude ... max_amplitude` range.
----
### [gain_ff](#gain_ff) ### [gain_ff](#gain_ff)
Syntax: Syntax:
@ -179,6 +187,8 @@ Syntax:
It multiplies all samples by `gain`. It multiplies all samples by `gain`.
----
### [clone](#clone) ### [clone](#clone)
Syntax: Syntax:
@ -187,6 +197,8 @@ Syntax:
It copies the input to the output. It copies the input to the output.
----
### [through](#through) ### [through](#through)
Syntax: Syntax:
@ -195,6 +207,8 @@ Syntax:
It copies the input to the output, while also displaying the speed of the data going through it. It copies the input to the output, while also displaying the speed of the data going through it.
----
### [none](#none) ### [none](#none)
Syntax: Syntax:
@ -203,6 +217,8 @@ Syntax:
The `csdr` process just exits with 0. The `csdr` process just exits with 0.
----
### [yes_f](#yes_f) ### [yes_f](#yes_f)
Syntax: Syntax: