From d77bbcfd0b0e526a0f461bce2d68ef55c07e11a8 Mon Sep 17 00:00:00 2001
From: "Jazz (gitea)" <jazz@airmail.cc>
Date: Tue, 14 Oct 2025 20:12:53 -0500
Subject: [PATCH] add readme

---
 readme.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..0fc116e
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,54 @@
+# this is so jank
+
+STM32 seems so very not designed to work with C++, but you can absolutely make it work.
+
+This project should compile from C++ as long as your arm-none-eabi-g++ is new enough... works on my machine anyways
+
+Change this part of Makefile below line 79 if you're not me:
+
+```
+#ifdef GCC_PATH
+GCC_PATH = $(HOME)/.arm-gcc/bin
+CC = $(GCC_PATH)/$(PREFIX)gcc
+CXX = $(GCC_PATH)/$(PREFIX)g++
+AS = $(GCC_PATH)/$(PREFIX)gcc -x assembler-with-cpp
+CP = $(GCC_PATH)/$(PREFIX)objcopy
+SZ = $(GCC_PATH)/$(PREFIX)size
+#else
+#CC = $(PREFIX)gcc
+#AS = $(PREFIX)gcc -x assembler-with-cpp
+#CP = $(PREFIX)objcopy
+#SZ = $(PREFIX)size
+#endif
+HEX = $(CP) -O ihex
+BIN = $(CP) -O binary -S
+```
+
+to this:
+
+```
+ifdef GCC_PATH
+CC = $(GCC_PATH)/$(PREFIX)gcc
+CXX = $(GCC_PATH)/$(PREFIX)g++
+AS = $(GCC_PATH)/$(PREFIX)gcc -x assembler-with-cpp
+CP = $(GCC_PATH)/$(PREFIX)objcopy
+SZ = $(GCC_PATH)/$(PREFIX)size
+else
+CC = $(PREFIX)gcc
+AS = $(PREFIX)gcc -x assembler-with-cpp
+CP = $(PREFIX)objcopy
+SZ = $(PREFIX)size
+endif
+HEX = $(CP) -O ihex
+BIN = $(CP) -O binary -S
+```
+
+### Not for release. See:
+
+```
+./Drivers/CMSIS/Documentation/General/html/LICENSE.txt
+./Drivers/CMSIS/Device/ST/STM32F4xx/LICENSE.txt
+./Drivers/CMSIS/DSP/ComputeLibrary/LICENSE.txt
+./Drivers/CMSIS/LICENSE.txt
+./Drivers/STM32F4xx_HAL_Driver/LICENSE.txt
+```