From 35b899906883736a95c53a5d5adf6b7663249347 Mon Sep 17 00:00:00 2001 From: ha7ilm Date: Sun, 2 Apr 2017 12:59:23 +0200 Subject: [PATCH] Docs: trying formatting --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 39d037d..4a0f909 100644 --- a/README.md +++ b/README.md @@ -140,17 +140,21 @@ You can use these commands on complex streams, too, as they are only interleaved > Note: The the functions with `i16` in their names have been renamed, but still work (e.g. `csdr convert_f_i16`). -#### csdr commands +### csdr commands `csdr` should be considered as a reference implementation on using `libcsdr`. For additional details on how to use the library, check `csdr.c` and `libcsdr.c`. 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 ``, optional parameters are noted as `[parameter]`. Optional parameters have safe defaults, for more info look at the code. +### [realpart_cf](#realpart_cf) + realpart_cf It takes the real part of the complex signal, and throws away the imaginary part. +### [clipdetect_ff](#clipdetect_ff) + 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. @@ -478,6 +482,8 @@ E.g. you can send `-0.05 0.02\n` You can search the functions available in `csdr` just as if you typed: `csdr 2>&1 | grep ` +### [=](#evaluate-python-expression> + = When running complicated `csdr` commands, we usually run into using `python` to calculate certain parameters.