From da8903d0d209dfd54a38b9b219f0e89d1765d2a0 Mon Sep 17 00:00:00 2001 From: Mario Fink Date: Fri, 5 Jul 2019 12:32:17 +0200 Subject: [PATCH] some readme --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 969d213..ff42436 100644 --- a/README.md +++ b/README.md @@ -34,14 +34,26 @@ wrapper. - eFloat32Usi: 32 byte - eFloat64Usi: 64 byte - main.cpp contains an example of how the C++ library might be used to provide - the channels and groups of the dataset. + the channels and groups of the dataset. It is simply build by + + ```Shell + make + ``` - extract_all.cpp takes the .tdm, the .tdx file and some output directory as arguments to provide all given information in .csv format without any logging. + ```Shell + make extall + ``` + ### Python module - The library may also be used as a Python module and supports the use of group channels in NumPy arrays as shown in example.py . - To extract all available information and data in the TDM files without any further interaction, the use of extract_all.py is recommended. To exhibit the - required arguments call $ python extract_all.py --help . + required arguments: + + ```Shell + python extract_all.py --help + ```