mario/TDMtermite
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

documentation install

Browse Source
This commit is contained in:
Mario Fink 2019-07-12 11:02:36 +02:00
parent 54b7cecccc
commit 0e249480ac
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -12,6 +12,30 @@ The .tdm is represented in XML format and basically reveals what data the .tdx
contains and how to read it. The XML tree is usually made up of several groups, contains and how to read it. The XML tree is usually made up of several groups,
each containing an arbitrary amount of channels. each containing an arbitrary amount of channels.
## Installation
The makefile provides targets for using the library both as native C++ extension
and as Python module. Building the C++ codes is done via
```Shell
make
# or
make extall
```
The package supports usage on Linux and MacOSX. The tdm_ripper module is built
on these platforms by
```Shell
make install
```
and
```Shell
make install_osx
```
## Usage ## Usage
Although the package is built upon a C++ core, which decodes the data, it may be Although the package is built upon a C++ core, which decodes the data, it may be