summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2020-10-24 17:25:28 +0200
committerxengineering <mail2xengineering@protonmail.com>2020-10-24 17:25:28 +0200
commit0fa18937f6cb17b41a1fe2b193dbb3c2a5c2ba45 (patch)
tree18dbfdd186b3520054a8da2175bde7bb26ff9b92 /README.md
parentc525dd5ad7fce95b615c856a485fa1448b40c374 (diff)
downloadstm32f103c8-examples-0fa18937f6cb17b41a1fe2b193dbb3c2a5c2ba45.tar
stm32f103c8-examples-0fa18937f6cb17b41a1fe2b193dbb3c2a5c2ba45.tar.zst
stm32f103c8-examples-0fa18937f6cb17b41a1fe2b193dbb3c2a5c2ba45.zip
Improve Documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index dc70883..3883df5 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,18 @@
+
# STM32F103C8 Examples
Example C code for the STM32F103C8 microcontrollers implemented with libopencm3. This repository is based on the [template project](https://github.com/libopencm3/libopencm3-template) for libopencm3.
+
+
+## Recommended Toolchain
+
+The toolchain described in this section is recommended to try out the software of this repository.
+
+### The Target: STM32 Blue Pill Board
+
+The STM32 Blue Pill board is based on the STM32F103C8 microcontroller. Because of the very low price it is an ideal board to try out the software of this repository.
+
+### The Debugger/Programmer: Black Magic Probe
+
+To program the target microcontroller you have to use a suitable programmer. A good choice could be the [Black Magic Probe](https://1bitsquared.com/products/black-magic-probe) (BMP). It has a built-in GDB server and serial debugger.