[README] Coarse sweep to use markup in READMEs.

This should improve online readability of the readme files.
This commit is contained in:
Piotr Esden-Tempski
2015-01-19 19:20:12 -08:00
parent ab7efee88e
commit 1c4ae95729
121 changed files with 411 additions and 609 deletions

View File

@@ -1,3 +1,5 @@
# README
This test sets up the CAN interface on Lisa/M and transmits 8 bites every
100ms. The first byte is being incremented in each cycle. The demo also
receives messages and is displaing the first 4 bits of the first byte on the

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB CDC-ACM device (aka Virtual Serial Port)
to demonstrate the use of the USB device stack.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB Device Firmware Upgrade (DFU) bootloader
to demonstrate the use of the USB device stack.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB Human Interface Device (HID)
to demonstrate the use of the USB device stack.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is a simple polling example that sends the value read out from the
temperature sensor ADC channel of the STM32 to the USART2.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is a simple example that sends the value read out from the
temperature sensor ADC channel of the STM32 to the USART2.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is a simple example that sends the value read out from the
temperature sensor ADC channel of the STM32 to the USART2.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is a simple example that sends the values read out from four ADC
channels of the STM32 to the USART2.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is a simple polling example that sends the value read out from the
temperature sensor ADC channel of the STM32 to the USART2.

View File

@@ -1,3 +1,5 @@
# README
This test sets up the CAN interface on Lisa/M and transmits 8 bites every
100ms. The first byte is being incremented in each cycle. The demo also
receives messages and is displaing the first 4 bits of the first byte on the

View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program demonstrates simple SPI transceive on Lisa/M 2.0 board
(http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details).
This example program demonstrates simple SPI transceive on
[Lisa/M 2.0 board](http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details).
The terminal settings for the receiving device/PC are 9600 8n1.

View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program demonstrates SPI transceive with DMA on Lisa/M 2.0 board
(http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details).
This example program demonstrates SPI transceive with DMA on
[Lisa/M 2.0 board](http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details).
The terminal settings for the receiving device/PC are 9600 8n1.

View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program demonstrates SPI transceive with DMA on Lisa/M 2.0 board
(http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details).
This example program demonstrates SPI transceive with DMA on
[Lisa/M 2.0 board](http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details).
The terminal settings for the receiving device/PC are 9600 8n1.

View File

@@ -1,12 +1,10 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program sends some characters on USART2 on Lisa/M 2.0 board
(see http://paparazzi.enac.fr/wiki/LisaM for details).
This example program sends some characters on USART2 on
[Lisa/M 2.0 board](see http://paparazzi.enac.fr/wiki/LisaM for details).
The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way in the code, see the usart_irq example
The sending is done in a blocking way in the code, see the usart\_irq example
for a more elaborate USART example.

View File

@@ -1,10 +1,8 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is a blink example program using libopencm3.
It's intended for the ST STM32-based MB525 eval board (see
http://www.st.com/stonline/products/literature/um/13472.htm for details).
It's intended for the ST STM32-based
[MB525 eval board](http://www.st.com/stonline/products/literature/um/13472.htm for details).
It should blink the LEDs on the board.

View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is a PWM based LED fading example using libopencm3.
It's intended for the ST STM32-based MB525 eval board (see
http://www.st.com/stonline/products/literature/um/13472.htm for details).
It's intended for the ST STM32-based
[MB525 eval board](http://www.st.com/stonline/products/literature/um/13472.htm for details).

View File

@@ -1,3 +1,5 @@
# README
This test sets up the CAN interface on Lisa/M and transmits 8 bites every
100ms. The first byte is being incremented in each cycle. The demo also
receives messages and is displaing the first 4 bits of the first byte on the

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program sends some characters on USART1.
Afterwards it read out the internal temperature sensor of the STM32 and

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This program demonstrates a little DMA MEM2MEM transfer. A string is sent out
to USART1 and afterwards copied by DMA to another memory location. To check

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program writes some text on an DOGM128 LCD display connected
to SPI2.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program sends some characters on USART1.
Afterwards it connects to an STTS75 sensor (ST LM75 compatible)

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is a small RTC example project.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program blinks a LED on PortB Pin 6. 1 second on / 1 second off.
Blinking is done via the systick timer interrupt.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program blinks a LED on PortB Pin 6. 1 second on / 1 second off.
Blinking is made only with the timer interrupt of the TIM2 timer.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB CDC-ACM device (aka Virtual Serial Port)
to demonstrate the use of the USB device stack.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB Device Firmware Upgrade (DFU) bootloader
to demonstrate the use of the USB device stack.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB Human Interface Device (HID)
to demonstrate the use of the USB device stack.

View File

@@ -1,10 +1,8 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is small LED blinking example program using libopencm3.
It's intended for the ST STM32-based Olimex STM32-H103 eval board (see
http://olimex.com/dev/stm32-h103.html for details). It should blink
the LED on the board.
It's intended for the ST STM32-based
[Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html).
It should blink the LED on the board.

View File

@@ -1,10 +1,8 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is the smallest-possible example program using libopencm3.
It's intended for the ST STM32-based Olimex STM32-H103 eval board (see
http://olimex.com/dev/stm32-h103.html for details). It should blink
the LED on the board.
It's intended for the ST STM32-based
[Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html).
It should blink the LED on the board.

View File

@@ -1,8 +1,5 @@
-------------------------------------------------------------------------------
README
-------------------------------------------------------------------------------
# README
This example program repeatedly sends characters on SPI1 on the ST STM32-based
Olimex STM32-H103 eval board (see http://olimex.com/dev/stm32-h103.html
for details).
[Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html).

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This experimental program sends some characters on the TRACESWO pin using
the Instrumentation Trace Macrocell (ITM) and Trace Port Interface Unit (TPIU).

View File

@@ -1,13 +1,10 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program sends some characters on USART3 on the ST STM32-based
Olimex STM32-H103 eval board (see http://olimex.com/dev/stm32-h103.html
for details).
[Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html).
The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way in the code, see the usart_irq example
The sending is done in a blocking way in the code, see the usart\_irq example
for a more elaborate USART example.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB CDC-ACM device (aka Virtual Serial Port)
to demonstrate the use of the USB device stack.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB Device Firmware Upgrade (DFU) bootloader
to demonstrate the use of the USB device stack.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB Human Interface Device (HID)
to demonstrate the use of the USB device stack.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB bootloader for the Paparazzi project.

View File

@@ -1,10 +1,8 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is small LED blinking example program using libopencm3.
It's intended for the ST STM32-based Olimex STM32-H107 eval board (see
http://olimex.com/dev/stm32-h107.html for details). It should blink
the LED on the board.
It's intended for the ST STM32-based
[Olimex STM32-H107 eval board](http://olimex.com/dev/stm32-h107.html).
It should blink the LED on the board.

View File

@@ -1,8 +1,9 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This small example program operates on internal FLASH memory by using libopencm3.
This small example program operates on internal FLASH memory by using
libopencm3.
It's intended for all devboards with STM32f107 microcontrollers. To use this example it is essential to use USART1 port.
It writes text string entered via serial port terminal (ex. teraterm) into internal FLASH memory and then it reads it.
It's intended for all devboards with STM32f107 microcontrollers. To use this
example it is essential to use USART1 port. It writes text string entered via
serial port terminal (ex. teraterm) into internal FLASH memory and then it
reads it.

View File

@@ -1,10 +1,8 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is small USB controlled LED blinking example program using libopencm3.
It's intended for the ST STM32-based Olimex STM32-H107 eval board (see
http://olimex.com/dev/stm32-h107.html for details). The usbtest.py
script in this directory maybe used to control the LED.
It's intended for the ST STM32-based
[Olimex STM32-H107 eval board](http://olimex.com/dev/stm32-h107.html).
The usbtest.py script in this directory maybe used to control the LED.

View File

@@ -1,9 +1,7 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is the smallest-possible example program using libopencm3.
It's intended for the ST STM32-based Leaf Labs Maple board (see
http://leaflabs.com for details). It should blink the LED on the board.
It's intended for the ST STM32-based
[Leaf Labs Maple board](http://leaflabs.com).
It should blink the LED on the board.

View File

@@ -1,13 +1,10 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program sends some characters on USART3 on the ST STM32-based
Olimex STM32-H103 eval board (see http://olimex.com/dev/stm32-h103.html
for details).
[Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html).
The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way in the code, see the usart_irq example
The sending is done in a blocking way in the code, see the usart\_irq example
for a more elaborate USART example.

View File

@@ -1,7 +1,5 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example implements a USB CDC-ACM device (aka Virtual Serial Port)
to demonstrate the use of the USB device stack.
This example implements a USB CDC-ACM device (aka Virtual Serial Port) to
demonstrate the use of the USB device stack.

View File

@@ -1,17 +1,20 @@
Console on PA2 (tx only) 115200@8n1
# README
* Prints the ADC value on PA0 (adc channel 0) on the console
Console on `PA2` (tx only) 115200@8n1
* Prints the ADC value on `PA0` (adc channel 0) on the console
* Echos half that ADC value out to DAC channel 2 on PA5
* Prints the ADC value of PA1 (adc channel 1) to the console.
* Prints the ADC value of `PA1` (adc channel 1) to the console.
Recommended wiring:
* pot or any resistor ladder to PA0
* jumper from PA5 to PA1
* pot or any resistor ladder to `PA0`
* 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
...

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example blinks the green LED on the ST STM32VLDISCOVERY eval board.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is the smallest-possible example program using libopencm3.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is the smallest-possible example program using libopencm3.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is a small RTC example project.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program demonstrates simple SPI transceive on stm32vl discovery board.

View File

@@ -1,12 +1,10 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example program sends some characters on USART1 on the
ST STM32VLDISCOVERY eval board.
The terminal settings for the receiving device/PC are 38400 8n1.
The sending is done in a blocking way in the code, see the usart_irq example
The sending is done in a blocking way in the code, see the usart\_irq example
for a more elaborate USART example.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example blinks LED1 on the WaveShare Open103R eval board.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This program will interleave the blinking of two sets of LEDs. LED1
and LED3 will blink at the same time and LED2 and LED4 will blink at

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example uses the joystick to control the four LEDs on the
WaveShare Open103R eval board. Joystick directions referenced here are

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is the smallest-possible example program using libopencm3.

View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example uses the USB port as a serial port and implements a
loopback interface that immediately echos back whatever it receives. After flashing the evaluation board with the usbserial program and connecting it to a host computer with a USB cable, you can run the echo.py command as follows: