Adding GitHub flavored markdown for README.

1 files changed, 86 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..054b0bc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,86 @@
+# Diagnostic Log and Trace
+
+Alexander Wenzel <Alexander.AW.Wenzel@bmw.de>
+
+## Overview
+----
+This component provides a log and trace interface, based on the
+standardised protocol specified in the AUTOSAR standard 4.0 DLT.
+This software can be used by GENIVI components and other applications as
+logging facility providing
+
+- the DLT shared library
+- the DLT daemon
+- the DLT daemon adaptors
+- the DLT client console utilities
+- the DLT test applications
+- the DLT unit tests
+
+The DLT daemon is the central component in GENIVI, which gathers all
+logs and traces from the DLT user applications. The logs and traces
+can optionally be directly written to a file in the ECU. The DLT daemon
+forwards all logs and traces to a connected DLT client.
+The DLT client can send control messages to the daemon, e.g. to set
+individual log levels of applications and contexts or get the list of
+applications and contexts registered in the DLT daemon.
+
+## Documentation
+----
+- DLT Release Notes: ReleaseNotes.txt
+- DLT Installation: INSTALL
+- DLT User Manual: doc/dlt_user_manual.txt
+- DLT Cheatsheet: doc/dlt_cheatsheet.txt
+- DLT Design Specification: doc/dlt_design_specification.txt
+- DLT Compilation of all documentation: doc/dlt_book.txt
+
+## API Documentation
+----
+See INSTALL regarding doxygen API documentation generation.
+
+## Manpages
+----
+- dlt-daemon(1)
+- dlt.conf(5)
+- dlt-system(1)
+- dlt-system.conf(5)
+- dlt-convert(1)
+- dlt-receive(1)
+- dlt-logstorage-ctrl(1)
+- dlt-dbus (1)      TBD
+- dlt-dbus.conf (5) TBD
+- dlt-cdh (1)       TBD
+- dlt-kpi (1)       TBD
+
+## Known issues
+------------
+- DLT library: Usage of dlt_user_log_write_float64() and DLT_FLOAT64() leads to "Illegal instruction (core dumped)" on ARM target.
+- DLT library: Nested calls to DLT_LOG_ ... are not supported, and will lead to a deadlock.
+
+## Software/Hardware
+-----------------
+Developed and tested with Fedora Linux 22 64-bit / Intel PC
+
+## License
+-------
+Full information on the license for this software is available in the "LICENSE" file. +
+Full information on the license for the cityhash code is available in "COPYING" file in src/core_dump_handler/cityhash_c.
+
+## Source Code
+-----------
+git://git.projects.genivi.org/dlt-daemon.git
+http://git.projects.genivi.org/dlt-daemon.git
+ssh://git-genivi@git.projects.genivi.org/dlt-daemon.git
+
+## Homepage
+--------
+http://projects.genivi.org/diagnostic-log-trace
+
+Mailinglist
+-----------
+https://lists.genivi.org/mailman/listinfo/genivi-diagnostic-log-and-trace
+
+Contact
+-------
+Alexander Wenzel <Alexander.AW.Wenzel@bmw.de>
+Lutz Helwing <Lutz_Helwing@mentor.com>
+