Update dependency version for xds agent & common

[src/xds/xds-gdb.git] / README.md

diff --git a/README.md b/README.md
index 389c03d..1de9c2b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,16 @@
-xds-gdb: wrapper on gdb for XDS
-=================================
+# xds-gdb
 
 `xds-gdb` is a wrapper on gdb debugger for X(cross) Development System.
+
+This tool allows you to debug an application built with an xds-server without
+the need to install gdb or any cross tool.
+
+## Documentation
+
+Please find XDS User's Guide online at :
+
+[http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide](http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide)
+
+and `xds-gdb` advanced documentation at :
+
+[http://docs.automotivelinux.org/docs/devguides/en/dev/reference/xds/part-2/4_xds-gdb.html](http://docs.automotivelinux.org/docs/devguides/en/dev/reference/xds/part-2/4_xds-gdb.html)