summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0306080..070c535 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,40 @@
A firmware project for the STM32F103C8T6 to control LED strips.
+## Usage
+
+Install the necessary software. For Arch Linux this works like this:
+```
+sudo pacman -S \
+ base-devel \
+ arm-none-eabi-binutils \
+ arm-none-eabi-gcc \
+ arm-none-eabi-gdb \
+ arm-none-eabi-newlib
+```
+
+Clone this repository with all Git submodules:
+```
+git clone --recurse-submodules https://gitea.xengineering.eu/xengineering/ledcontrol.git
+```
+
+Enter the repository and build the software
+```
+cd ledcontrol
+make
+```
+
+Connect your STM32F103C8T6 with an STLINK V2 debugger and flash the firmware:
+```
+bash ocd.sh
+# switch to a second terminal in the same folder
+bash gdb.sh build/ledcontrol.elf
+load
+run
+# CTRL + C will stop the execution
+# leave GDB with CTRL + D
+```
+
## External References
- Nice [Tutorial](https://jacobmossberg.se/posts/2018/08/11/run-c-program-bare-metal-on-arm-cortex-m3.html) about C programs on bare-metal ARM chips