Add readme and cleanup formatting cleanup

[~andy/csm213a-hw] / hw2 / readme.txt

diff --git a/hw2/readme.txt b/hw2/readme.txt
new file mode 100644 (file)
index 0000000..18e27ad
--- /dev/null
+++ b/hw2/readme.txt
@@ -0,0 +1,22 @@
+Primary mbed:
+    main.cpp        - Primary program to control mbed
+    main_time.[ch]  - Time synchronization functions
+    main_comm.[ch]  - Serial communication functions
+    main_emit.[ch]  - Periodic signal generation functions
+
+Testing mbed:
+    tester.cpp      - Mbed 3 testing program
+
+Host control:
+    control.c       - Linux program to control primary mbeds
+
+Miscellaneous:
+    examples.cpp    - Device testing routines (not used)
+
+Common files:
+    messages.[ch]   - Message definitions for mbed <--> {bbb,host}
+
+KL46Z Libraries:
+    serial_dma.[ch] - DMA based serial I/O (not used)
+    serial_irq.[ch] - Interrupt driven serial I/O
+    timer_dma.[ch]  - Time stamping using DMA and PIT