aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorTat-Chee Wan (USM)2011-03-02 08:29:33 +0800
committerTat-Chee Wan (USM)2011-03-02 08:29:33 +0800
commit39058288d8ab2ed1486cefdc8547d25c3d723a8c (patch)
tree97747a32301b72a07cd5338426e6f395ad21c6cb /README
parent1b81593dc78daf9eab6acc02255f6f9e14b93d09 (diff)
Added simple README to list folders contents
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 19 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..9b6bca3
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
+Introduction
+============
+armdebug is an ARM Assembly Language Instruction debugger for the NXT.
+It is intended for embedding in the NXT firmware (e.g. NXT Improved Firmware),
+as well as for use with NxOS.
+
+Contents
+========
+The various folders contents are as follows:
+Debugger: GDB client driver for NXT (need to be embedded in firmware code)
+Host: GDB Server for PC Host
+FantomModule: pyFantom - Python Wrapper for Fantom Driver on Mac OSX (used by nxt-python)
+nxt-python-fantom: Local fork of nxt-python to support pyFantom
+
+
+LICENCES
+========
+The armdebug code is dual-licensed. Please see COPYING for more details.
+Other projects included in this repository have their respective licenses.