From 4df9d52d67f1ab3c47d2e45127e7b047e51fb1cb Mon Sep 17 00:00:00 2001 From: ha7ilm Date: Sun, 2 Apr 2017 13:02:53 +0200 Subject: [PATCH] Docs: even more formatting --- README.md | 46 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4a0f909..51c7ab2 100644 --- a/README.md +++ b/README.md @@ -149,40 +149,70 @@ Optional parameters have safe defaults, for more info look at the code. ### [realpart_cf](#realpart_cf) - realpart_cf +Syntax: + + csdr realpart_cf It takes the real part of the complex signal, and throws away the imaginary part. ### [clipdetect_ff](#clipdetect_ff) - clipdetect_ff +Syntax: + + csdr clipdetect_ff 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 [max_amplitude] +### [limit_ff](#limit_ff) + +Syntax: + + csdr limit_ff [max_amplitude] The input signal amplitude will not be let out of the `-max_amplitude ... max_amplitude` range. - gain_ff +### [gain_ff](#gain_ff) + +Syntax: + + csdr gain_ff It multiplies all samples by `gain`. - clone +### [clone](#clone) + +Syntax: + + csdr clone It copies the input to the output. - through +### [through](#through) + +Syntax: + + csdr through It copies the input to the output, while also displaying the speed of the data going through it. - none +### [none](#none) + +Syntax: + + csdr none The `csdr` process just exits with 0. - yes_f [buf_times] +### [yes_f](#yes_f) + +Syntax: + + csdr yes_f [buf_times] It outputs continously the `to_repeat` float number. + If `buf_times` is not given, it never stops. + Else, after outputing `buf_times` number of buffers (the size of which is stated in the `BUFSIZE` macro), it exits. detect_nan_ff