summary history branches tags files
commit:ed989188c5dbebd79e0fbe40af45c9a5004a1bd7
author:mrmekon
committer:mrmekon
date:Thu Nov 8 17:37:13 2012 -0500
parents:5228de6f5acd2d13a2c73ab305f9d57b5aad4f50
More README
diff --git a/README.md b/README.md
line changes: +29/-4
index 607cfd3..a789947
--- a/README.md
+++ b/README.md
@@ -1,13 +1,38 @@
 ## picdb
 =====
 
-Command-line debugger for Microchip PIC processors
+Python-based command-line debugger for Microchip PIC processors.
 
-Debugger written in jython.  Interacts with the Java API provided by Microchip in the MPLAB X installation.
+Debugger written in Python, and requires jython for execution.  Interacts with the Java mdbcore API provided by Microchip in the MPLAB X installation.  This is the same API used by Microchip's currently incomplete "mdb.sh", and MPLAB X itself.
 
-For now this is an early demonstration, working only with the PICkit3 and PIC32MX150F128B processor.
+For now this is an early demonstration, working only with the PICkit3 and tested only with the PIC32MX150F128B processor.
 
-Verify path to JARs is correct in picdb.sh, and run picdb.sh.
+I wrote this because mdb.sh is currently incomplete, and nearly unusable, so loading or debugging PIC code at the command-line was impossible.
+
+
+## Running
+=====
+
+1) Verify path to JARs is correct in picdb.sh
+2) run picdb.sh.
+
+
+## Supported features
+=====
+
+* Basic debugger commands
+    * connect (connect to debugger and target device)
+    * load (load ELF file onto target)
+    * break (add breakpoints)
+    * breakpoints (list breakpoints)
+    * continue (run target)
+    * step (step target -- currently StepOver only)
+    * print (print information about something -- currently only Program Counter)
+    * help (list possible commands, or display specific command's help)
+    * quit
+* Readline input handling supports up/down keys, and history.
+* Address-to-Source-Line conversions when stepping.
+* Partial assembly code output when stepping.
 
 
 ## Example session