[README] Coarse sweep to use markup in READMEs.

This should improve online readability of the readme files.
2015-01-19 19:20:12 -08:00
parent ab7efee88e
commit 1c4ae95729
121 changed files with 411 additions and 609 deletions
--- a/examples/stm32/f4/other/crypto-basic/README.md
+++ b/examples/stm32/f4/other/crypto-basic/README.md
@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example program is for demonstrating of use Crypto Controller on STM32F417
 board.
--- a/examples/stm32/f4/stm32f4-discovery/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/README.md
@@ -1,3 +1,5 @@
+# README
+
 This directory contains examples for the _original_ stm32f4 discovery.
 The PCB should be labelled either MB997A or MB997B, and contains a user USB
 port, and an audio dac on board, along with a MEMs microphone and an
--- a/examples/stm32/f4/stm32f4-discovery/adc-dac-printf/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/adc-dac-printf/README.md
@@ -1,3 +1,5 @@
+# README
+
 Console on PA2 (tx only)  115200@8n1

 * Prints the ADC value on PA0 (adc channel 0) on the console
@@ -9,9 +11,9 @@ Recommended wiring:
 * jumper from PA5 to PA1

 example output:
-...
-tick: 228: adc0= 3950, target adc1=1975, adc1=1979
-tick: 229: adc0= 3949, target adc1=1974, adc1=1978
-tick: 230: adc0= 3950, target adc1=1975, adc1=1979
-tick: 231: adc0= 3949, target adc1=1974, adc1=1978
-...
+    ...
+    tick: 228: adc0= 3950, target adc1=1975, adc1=1979
+    tick: 229: adc0= 3949, target adc1=1974, adc1=1978
+    tick: 230: adc0= 3950, target adc1=1975, adc1=1979
+    tick: 231: adc0= 3949, target adc1=1974, adc1=1978
+    ...
--- a/examples/stm32/f4/stm32f4-discovery/button/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/button/README.md
@@ -1,12 +1,9 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example blinks the GREEN LED on the ST STM32F4DISCOVERY eval board.

 When you press the 'USER' button, the blinking is slower.

-Board connections:
------------------
+## Board connections

- <none required>
+*none required*
--- a/examples/stm32/f4/stm32f4-discovery/dac-dma/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/dac-dma/README.md
@@ -1,3 +1,5 @@
+# README
+
 DAC test with DMA and timer 2 trigger

 Timer 2 is setup to provide a trigger signal on OC1, with a period of 142 Hz
--- a/examples/stm32/f4/stm32f4-discovery/fancyblink/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/fancyblink/README.md
@@ -1,13 +1,10 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This is the smallest-possible example program using libopencm3.

 It's intended for the ST STM32F4DISCOVERY eval board. It should blink
 the LEDs on the board.

-Board connections:
------------------
+## Board connections

- <none required>
+*none required*
--- a/examples/stm32/f4/stm32f4-discovery/mandelbrot/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/mandelbrot/README.md
@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example program demonstrates the floating point coprocessor usage on
 the ST STM32F4DISCOVERY eval board.
@@ -8,7 +6,8 @@ the ST STM32F4DISCOVERY eval board.
 A mandelbrot fractal is calculated and sent as "ascii-art" image through
 the USART2.

-Board connections:
------------------
+## Board connections

-  PA2	(USART2_TX)	TTL serial output (38400,8,N,1)
+| Port  | Function      | Description                       |
+| ----- | ------------- | --------------------------------- |
+| `PA2` | `(USART2_TX)` | TTL serial output `(38400,8,N,1)` |
--- a/examples/stm32/f4/stm32f4-discovery/miniblink/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/miniblink/README.md
@@ -1,13 +1,10 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This is the smallest-possible example program using libopencm3.

 It's intended for the ST STM32F4DISCOVERY eval board. It should blink
 the GREEN LED on the board.

-Board connections:
------------------
+## Board connections

- <none required>
+*none required*
--- a/examples/stm32/f4/stm32f4-discovery/random/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/random/README.md
@@ -1,12 +1,9 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example randomly blinks the GREEN LED on the ST STM32F4DISCOVERY eval
 board.

-Board connections:
------------------
+## Board connections

- <none required>
+*none required*

--- a/examples/stm32/f4/stm32f4-discovery/tick_blink/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/tick_blink/README.md
@@ -1,14 +1,11 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

-This example is the same as fancy_blink except that it uses the
+This example is the same as fancy\_blink except that it uses the
 systick timer to generate time accurate delays. Shows how to set
 up the systick timer to create an interrupt every millisecond and
 how to write a delay routine (msleep) that can then delay for a
 specific number of milliseconds.

-Board connections:
------------------
+## Board connections

- <none required>
+*none required*
--- a/examples/stm32/f4/stm32f4-discovery/usart/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/usart/README.md
@@ -1,13 +1,12 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example program sends repeating sequence of characters "0123456789" on 
 USART2 on the ST STM32F4DISCOVERY eval board.

 The sending is done in a blocking way.

-Board connections:
------------------
+## Board connections

-  PA2	(USART2_TX)	TTL serial output (38400,8,N,1)
+| Port  | Function      | Description                       |
+| ----- | ------------- | --------------------------------- |
+| `PA2` | `(USART2_TX)` | TTL serial output `(38400,8,N,1)` |
--- a/examples/stm32/f4/stm32f4-discovery/usart_irq/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/usart_irq/README.md
@@ -1,14 +1,13 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example program echoes data sent in on USART2 on the
 ST STM32F4DISCOVERY eval board. Uses interrupts for that purpose.

 The sending is done in a nonblocking way.

-Board connections:
------------------
+## Board connections

-  PA2	(USART2_TX)	TTL serial output (38400,8,N,1)
-  PA3	(USART2_RX)	TTL serial input (38400,8,N,1)
+| Port  | Function      | Description                       |
+| ----- | ------------- | --------------------------------- |
+| `PA2` | `(USART2_TX)` | TTL serial output `(38400,8,N,1)` |
+| `PA3` | `(USART2_RX)` | TTL serial input `(38400,8,N,1)`  |
--- a/examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README.md
@@ -1,11 +1,10 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example implements a USB CDC-ACM device (aka Virtual Serial Port)
 to demonstrate the use of the USB device stack.

-Board connections:
------------------
+## Board connections

-  CN5	(USB_OTG_FS)	USB acting as device, connect to computer
+| Port  | Function       | Description                               |
+| ----- | -------------- | ----------------------------------------- |
+| `CN5` | `(USB_OTG_FS)` | USB acting as device, connect to computer |
--- a/examples/stm32/f4/stm32f4-discovery/usb_midi/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/usb_midi/README.md
@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example implements a USB MIDI device to demonstrate the use of the
 USB device stack. It implements the device configuration found in Appendix
@@ -11,13 +9,13 @@ The 'USER' button sends note on/note off messages.
 The board will also react to identity request (or any other data sent to
 the board) by transmitting an identity message in reply.

-Board connections:
------------------
+## Board connections

-  CN5	(USB_OTG_FS)	USB acting as device, connect to computer
+| Port  | Function       | Description                               |
+| ----- | -------------- | ----------------------------------------- |
+| `CN5` | `(USB_OTG_FS)` | USB acting as device, connect to computer |

-Testing
-------
+## Testing

 To list midi devices, which should include this demo device

@@ -37,7 +35,7 @@ To record events, while pushing the user button
    12 bytes read
    $

-To query the system identity, note this dump matches sysex_identity[] in the
+To query the system identity, note this dump matches sysex\_identity[] in the
 source.

    $ amidi -d -p hw:2,0,0 -s Sysexdump.syx
--- a/examples/stm32/f4/stm32f4-discovery/usb_msc/README.md
+++ b/examples/stm32/f4/stm32f4-discovery/usb_msc/README.md
@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example implements a USB Mass Storage Class (MSC) device
 to demonstrate the use of the USB device stack.
--- a/examples/stm32/f4/stm32f429i-discovery/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/README.md
@@ -1,3 +1,5 @@
+# README
+
 This directory contains examples for the stm32f429i discovery board.
 The PCB should be labelled either MB1075B, and contains a user USB
 port, 2.4" QVGA TFT LCD display, 64Mbits external SDRAM and ST MEMS gyroscope.
--- a/examples/stm32/f4/stm32f429i-discovery/adc-dac-printf/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/adc-dac-printf/README.md
@@ -1,3 +1,5 @@
+# README
+
 Console on PA9 (tx only)  115200@8n1

 * Prints the ADC value on PA0 (adc channel 0) on the console
@@ -9,9 +11,9 @@ Recommended wiring:
 * jumper from PA5 to PA1

 example output:
-...
-tick: 228: adc0= 3950, target adc1=1975, adc1=1979
-tick: 229: adc0= 3949, target adc1=1974, adc1=1978
-tick: 230: adc0= 3950, target adc1=1975, adc1=1979
-tick: 231: adc0= 3949, target adc1=1974, adc1=1978
-...
+    ...
+    tick: 228: adc0= 3950, target adc1=1975, adc1=1979
+    tick: 229: adc0= 3949, target adc1=1974, adc1=1978
+    tick: 230: adc0= 3950, target adc1=1975, adc1=1979
+    tick: 231: adc0= 3949, target adc1=1974, adc1=1978
+    ...
--- a/examples/stm32/f4/stm32f429i-discovery/button/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/button/README.md
@@ -1,12 +1,9 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example blinks the GREEN LED on the ST STM32F429IDISCOVERY eval board.

 When you press the 'USER' button, the blinking is slower.

-Board connections:
------------------
+## Board connections

- <none required>
+*none required*
--- a/examples/stm32/f4/stm32f429i-discovery/dac-dma/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/dac-dma/README.md
@@ -1,3 +1,5 @@
+# README
+
 DAC test with DMA and timer 2 trigger

 Timer 2 is setup to provide a trigger signal on OC1, with a period of 142 Hz
--- a/examples/stm32/f4/stm32f429i-discovery/fancyblink/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/fancyblink/README.md
@@ -1,13 +1,10 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This is the smallest-possible example program using libopencm3.

 It's intended for the ST STM32F429IDISCOVERY eval board. It should blink
 the LEDs on the board.

-Board connections:
------------------
+## Board connections

- <none required>
+*none required*
--- a/examples/stm32/f4/stm32f429i-discovery/mandelbrot/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/mandelbrot/README.md
@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example program demonstrates the floating point coprocessor usage on
 the ST STM32F429IDISCOVERY eval board.
@@ -8,7 +6,8 @@ the ST STM32F429IDISCOVERY eval board.
 A mandelbrot fractal is calculated and sent as "ascii-art" image through
 the USART1.

-Board connections:
------------------
+## Board connections

-  PA9	(USART1_TX)	TTL serial output (38400,8,N,1)
+| Port  | Function      | Description                       |
+| ----- | ------------- | --------------------------------- |
+| `PA9` | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` |
--- a/examples/stm32/f4/stm32f429i-discovery/miniblink/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/miniblink/README.md
@@ -1,13 +1,10 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This is the smallest-possible example program using libopencm3.

 It's intended for the ST STM32F429IDISCOVERY eval board. It should blink
 the GREEN LED on the board.

-Board connections:
------------------
+## Board connections

- <none required>
+*none required*
--- a/examples/stm32/f4/stm32f429i-discovery/random/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/random/README.md
@@ -1,12 +1,9 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example randomly blinks the GREEN LED on the ST STM32F429IDISCOVERY eval
 board.

-Board connections:
------------------
+## Board connections

- <none required>
+*none required*

--- a/examples/stm32/f4/stm32f429i-discovery/tick_blink/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/tick_blink/README.md
@@ -1,14 +1,11 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

-This example is the same as fancy_blink except that it uses the
+This example is the same as fancy\_blink except that it uses the
 systick timer to generate time accurate delays. Shows how to set
 up the systick timer to create an interrupt every millisecond and
 how to write a delay routine (msleep) that can then delay for a
 specific number of milliseconds.

-Board connections:
------------------
+## Board connections

- <none required>
+*none required*
--- a/examples/stm32/f4/stm32f429i-discovery/usart/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/usart/README.md
@@ -1,19 +1,17 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example program sends repeating sequence of characters "0123456789" on 
 USART1 on the ST STM32F429IDISCOVERY eval board.

 The sending is done in a blocking way.

-Board connections:
------------------
+## Board connections

-  PA9	(USART1_TX)	TTL serial output (38400,8,N,1)
+| Port  | Function      | Description                       |
+| ----- | ------------- | --------------------------------- |
+| `PA9` | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` |

-Notes:
------
+## Notes

 You can connect the UART to the stlink by closing the SB11 and SB15 solder
 jumpers.
--- a/examples/stm32/f4/stm32f429i-discovery/usart_irq/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/usart_irq/README.md
@@ -1,19 +1,17 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example program echoes data sent in on USART1 on the
 ST STM32F429IDISCOVERY eval board. Uses interrupts for that purpose.

 The sending is done in a nonblocking way.

-Board connections:
------------------
+## Board connections

-  PA9	(USART1_TX)	TTL serial output (38400,8,N,1)
-  PA10	(USART1_RX)	TTL serial input (38400,8,N,1)
+| Port   | Function      | Description                       |
+| ------ | ------------- | --------------------------------- |
+| `PA9`  | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` |
+| `PA10` | `(USART1_RX)` | TTL serial input `(38400,8,N,1)`  |

-Notes:
------
+## Notes

 You can connect the USART to the stlink by closing the SB11 and SB15 jumpers.
--- a/examples/stm32/f4/stm32f429i-discovery/usb_cdcacm/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/usb_cdcacm/README.md
@@ -1,11 +1,10 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example implements a USB CDC-ACM device (aka Virtual Serial Port)
 to demonstrate the use of the USB device stack.

-Board connections:
------------------
+## Board connections

-  CN6	(USB_OTG_HS)	USB acting as device, connect to computer
+| Port  | Function       | Description                               |
+| ----- | -------------- | ----------------------------------------- |
+| `CN6` | `(USB_OTG_HS)` | USB acting as device, connect to computer |
--- a/examples/stm32/f4/stm32f429i-discovery/usb_midi/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/usb_midi/README.md
@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example implements a USB MIDI device to demonstrate the use of the
 USB device stack. It implements the device configuration found in Appendix
@@ -11,13 +9,13 @@ The 'USER' button sends note on/note off messages.
 The board will also react to identity request (or any other data sent to
 the board) by transmitting an identity message in reply.

-Board connections:
------------------
+## Board connections

-  CN6	(USB_OTG_HS)	USB acting as device, connect to computer
+| Port  | Function       | Description                               |
+| ----- | -------------- | ----------------------------------------- |
+| `CN6` | `(USB_OTG_HS)` | USB acting as device, connect to computer |

-Testing
-------
+## Testing

 To list midi devices, which should include this demo device

@@ -37,7 +35,7 @@ To record events, while pushing the user button
    12 bytes read
    $

-To query the system identity, note this dump matches sysex_identity[] in the
+To query the system identity, note this dump matches sysex\_identity[] in the
 source.

    $ amidi -d -p hw:2,0,0 -s Sysexdump.syx
--- a/examples/stm32/f4/stm32f429i-discovery/usb_msc/README.md
+++ b/examples/stm32/f4/stm32f429i-discovery/usb_msc/README.md
@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
-README
------------------------------------------------------------------------------
+# README

 This example implements a USB Mass Storage Class (MSC) device
 to demonstrate the use of the USB device stack.