Add toplevel README.md

Git mirrors of the repository can now show a short description of the
project allowing developers to grasp the idea of the project.

An example of a rendered README.md can be seen here[1].

[1] https://github.com/eclipse/tcf.agent/tree/master/docker

Change-Id: I18d223595ebaf5beea99b8b1b2a29f3419a7c52d
Signed-off-by: Sanimir Agovic <sanimir@subpath.org>
1 file changed
tree: b8fff15c37fbf66a265271767369abe0ceed9686
  1. agent/
  2. docker/
  3. examples/
  4. server/
  5. tests/
  6. .gitignore
  7. .mailmap
  8. cmake-tcf-lib.txt
  9. README.md
README.md

Target Communication Framework

TCF is a vendor-neutral, lightweight, extensible network protocol mainly for communicating with embedded systems (targets). On top of the protocol specification, which is the core of TCF, the project includes a plain-C implementation of a lightweight extendable target agent, Java client API (usable stand-alone or on top of Eclipse), Python and Lua client APIs, complete debugger UI implementation in Eclipse, integration with CDT, Target Explorer, documentation and usage examples.

Contents

agent : The reference agent, implementing debug related services e.g. Memory, RunControl, Registers, Stacktrace, Breakpoints, Symbols, LineNumbers, Expressions.

docker : Dockerfile image for host and cross builds of the debug agent.

examples : Implementation of a daytime service.

server : A proxy server sitting between the client on the host and an agent running/embedded on the target as part of the firmware or RTOS. It implements Symbols and LineNumbers services.

tests : Standalone tools for testing (e.g dwarf, extended commandline client)

Links