Merge pull request #1 from FrameworkComputer/readme

Properly format README

Author: kiram9

README.md

@@ -1,24 +1,25 @@
-=== Multi purpose debugger - target controller 
+# Multi purpose debugger - target controller
 
-Supports 
-CMSIS-DAP 
-Multiple serial terminals 
-GPIO read/write/port register control. 
+Supports:
 
+- CMSIS-DAP
+- Multiple serial terminals
+- GPIO read/write/port register control.
 
-right now the backend uses raw hid reports for debug communication, terminal.py will open an interactive terminal to the device. 
+Right now the backend uses raw hid reports for debug communication, terminal.py will open an interactive terminal to the device.
 
-= How to flash to the teensy board: 
+### How to flash to the teensy board:
+```sh
 pio run -e teensy41 --target upload
 pio run -e teensy31 --target upload
 pio run -e teensy36 --target upload
+```
 
+### Modifications required to teensy 3.1 codebase:
 
-= Modifications required to teensy 3.1 codebase:
+For this to work you need to modify the teensy source code to set the RAWHID iInterface field to 2 to use the product string around line 1136 in `~/.platformio/packages/framework-arduinoteensy/cores/teensy3/usb_desc.c`
 
-* For this to work you need to modify the teensy source code to set the RAWHID iInterface field to 2 to use the product string
-around line 1136 in ~/.platformio/packages/framework-arduinoteensy/cores/teensy3/usb_desc.c
---------------------------------------
+```c
 #ifdef RAWHID_INTERFACE
         // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
         9,                                      // bLength
@@ -30,11 +31,11 @@ around line 1136 in ~/.platformio/packages/framework-arduinoteensy/cores/teensy3
         0x00,                                   // bInterfaceSubClass
         0x00,                                   // bInterfaceProtocol
         2,                                      // iInterface   <-------------------Modify this!
+```
 
-
-usb_desc.h 
---------------------------------------
-Add the following to the usb definitions section after USB_EVERYTHING
+`usb_desc.h`
+```c
+// Add the following to the usb definitions section after USB_EVERYTHING
 #elif defined(USB_RAWHID_TRIPLESERIAL)
  #define VENDOR_ID		0x16C0
   #define PRODUCT_ID		0x048C
@@ -99,33 +100,34 @@ Add the following to the usb definitions section after USB_EVERYTHING
 
   #define ENDPOINT11_CONFIG	ENDPOINT_TRANSMIT_ONLY
   #define ENDPOINT12_CONFIG	ENDPOINT_RECEIVE_ONLY
+```
 
 
-
-yeld.cpp 
---------------------------------------
-need to add USB_RAWHID_TRIPLESERIAL wherever USB_TRIPLE_SERIAL is. 
+`yeld.cpp`
+```c
+// Need to add USB_RAWHID_TRIPLESERIAL wherever USB_TRIPLE_SERIAL is.
 defined(USB_TRIPLE_SERIAL) || defined(USB_RAWHID_TRIPLESERIAL)
+```
 
-
-usb_inst.cpp
----------------------------------------
-Add defined(USB_RAWHID_TRIPLESERIAL) to 
+`usb_inst.cpp`
+```c
+// Add defined(USB_RAWHID_TRIPLESERIAL) to
 defined(USB_SERIAL) || defined(USB_DUAL_SERIAL) ||....
+```
 
-./platforms/teensy/builder/frameworks/arduino.py
----------------------------------------
-Add USB_RAWHID_TRIPLESERIAL
-
-to the section 
+`./platforms/teensy/builder/frameworks/arduino.py`
+```c
+// Add USB_RAWHID_TRIPLESERIAL
+// to the section
 BUILTIN_USB_FLAGS = (
+```
 
 
-
-= Modifications required for teensy 4.1
-* For this to work you need to modify the teensy source code to set the RAWHID iInterface field to 2 to use the product string
+### Modifications required for teensy 4.1
+For this to work you need to modify the teensy source code to set the RAWHID iInterface field to 2 to use the product string
 --------------------------------------
-Around line 1191 in ~/.platformio/packages/framework-arduinoteensy/cores/teensy4/usb_desc.c
+Around line 1191 in `~/.platformio/packages/framework-arduinoteensy/cores/teensy4/usb_desc.c`
+```c
 #ifdef RAWHID_INTERFACE
         // configuration for 480 Mbit/sec speed
         // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
@@ -138,10 +140,11 @@ Around line 1191 in ~/.platformio/packages/framework-arduinoteensy/cores/teensy4
         0x00,                                   // bInterfaceSubClass
         0x00,                                   // bInterfaceProtocol
         2,                                      // iInterface
+```
 
---------------------------------------
-usb_desc.h 
 
+`usb_desc.h`
+```c
 #elif defined(USB_RAWHID_TRIPLESERIAL)
   #define VENDOR_ID             0x16C0
   #define PRODUCT_ID            0x048C
@@ -197,11 +200,12 @@ usb_desc.h
 /* for raw hid */
   #define ENDPOINT8_CONFIG      ENDPOINT_RECEIVE_UNUSED + ENDPOINT_TRANSMIT_INTERRUPT
   #define ENDPOINT9_CONFIG      ENDPOINT_RECEIVE_INTERRUPT + ENDPOINT_TRANSMIT_UNUSED
+```
 
----------------------------------------
-./platforms/teensy/builder/frameworks/arduino.py
----------------------------------------
-Add USB_RAWHID_TRIPLESERIAL
 
-to the section 
-BUILTIN_USB_FLAGS = (
+`./platforms/teensy/builder/frameworks/arduino.py`
+```c
+// Add USB_RAWHID_TRIPLESERIAL
+// to the section
+BUILTIN_USB_FLAGS = (
+```