From c3ffd3bbf82142a2e45341f5e630b0595cd0031f Mon Sep 17 00:00:00 2001
From: Alessandro Mauri <alemauri001@gmail.com>
Date: Tue, 19 May 2026 00:02:47 +0200
Subject: [PATCH] better readme

---
 fw/README    |  9 ---------
 fw/README.md | 26 ++++++++++++++++++++++++++
 2 files changed, 26 insertions(+), 9 deletions(-)
 delete mode 100644 fw/README
 create mode 100644 fw/README.md

diff --git a/fw/README b/fw/README
deleted file mode 100644
index 7f41479..0000000
--- a/fw/README
+++ /dev/null
@@ -1,9 +0,0 @@
-SHRIM
-   __-------._
-_`   __===O~O_\.
-   / \ _ __w_=
-  /___ /~^
- |    |~^
-  \ __\~^   \ V/
-   \_ _\ __ / /
-     `- __|_-'
diff --git a/fw/README.md b/fw/README.md
new file mode 100644
index 0000000..fad8c1c
--- /dev/null
+++ b/fw/README.md
@@ -0,0 +1,26 @@
+# USB-C Soldering Iron Firmware
+
+```
+SHRIM
+   __-------._
+_`   __===O~O_\.
+   / \ _ __w_=
+  /___ /~^
+ |    |~^
+  \ __\~^   \ V/
+   \_ _\ __ / /
+     `- __|_-'
+```
+
+## Special thanks to:
+
+* cnlohr and all the contributors of [ch32fun][ch32fun]
+* deftio for [FR_math][frmath] which I briefly used
+* olkiarus for [u8g2][u8g2]
+* The Swedish Institute of Computer Science for [protothreads][pt]
+
+
+[ch32fun]: https://github.com/cnlohr/ch32fun
+[frmath]: https://github.com/deftio/fr_math
+[u8g2]: https://github.com/olikraus/u8g2
+[pt]: https://dunkels.com/adam/pt/index.html