Skip to content

Commit

Permalink
Rework README.md
Browse files Browse the repository at this point in the history
Remove obsolete README.txt

<Signed-off-by: Gernot Wirschal <gernot.wirschal@bmw.de>
  • Loading branch information
Gernot Wirschal committed Apr 13, 2018
1 parent 7e16b16 commit c2d8147
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 79 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Diagnostic Log and Trace Viewer

## Overview
Expand All @@ -13,7 +12,21 @@ The Diagnostic Log and Trace Viewer is an application that can send and receive
### Command line usage;

+ Windows: `dlt_viewer.exe [OPTIONS]`
+ Linux: ```dlt_viewer [OPTIONS] Options: -h Print usage (only in Linux) -p projectfile Loading project file on startup (must end with .dlp) -l logfile Loading logfile on startup (must end with .dlt) -f filterfile Loading filterfile on startup (must end with .dlf) -c logfile textfile Convert logfile file to textfile (logfile must end with .dlt) -e "name of plugin|command in plugin|param1|param2|paramn..." Execute command in a command interface plugin. -s Enable silent mode without warning message boxes```
+ Linux: `dlt_viewer [OPTIONS]`

Options:
+ `-h` Print usage
+ `-p projectfile` Loading project file on startup (must end with .dlp)
+ `-l logfile` Loading logfile on startup (must end with .dlt)
+ `-f filterfile` Loading filterfile on startup (must end with .dlf)
+ `-s or --silent` Enable silent mode without warning message boxes
+ `-v or --version` Only show version and buildtime information
+ `-c logfile textfile` Convert logfile file to textfile (logfile must end with .dlt)
+ `-u` Conversion will be done in UTF8 instead of ASCII";
+ `-csv` Conversion will be done in CSV format";
+ `-d` Conversion will NOT be done, save in dlt file format again instead"
+ `-dd` Conversion will NOT be done, save as decoded messages in dlt format"
+ `-e "name of plugin|command in plugin|param1|..|param<n>"` Execute a plugin command with <n> parameters

## API Documentation

Expand All @@ -22,13 +35,14 @@ See INSTALL.txt regarding doxygen API documentation generation.
## Software/Hardware

Developed with QT 5 (http://qt-project.org/)
Tested with Windows 7 + Qt 5.5.1 + MinGW 4.9.1
Tested with Windows 7 + Qt 5.5.1 + MSVC 2013 Express
Tested with Ubuntu Linux 14.04 + Qt 5.5.1
Tested with Windows 7 + Qt 5.6.1 + MSVC 2015 Express
Tested with Windows 7 + Qt 5.8.0 + MSVC 2015 Express
Tested with Ubuntu Linux 16.04 + Qt 5.5.1
Tested with macOS Sierra + Qt 5.7.0
Dynamically linked open source software

Qt 5.5.1 (LGPLv3 - Qt)
Qt 5.8.1 (LGPLv3 - Qt)
GCC (GPL)
(Optional) Mingw (GPL + BSD Variante + Public Domain)
Open Icon Library (http://openiconlibrary.sourceforge.net,Multiple LIcenses)
Expand Down
74 changes: 0 additions & 74 deletions README.txt

This file was deleted.

0 comments on commit c2d8147

Please sign in to comment.