aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLouis Burda <quent.burda@gmail.com>2024-08-19 18:44:47 +0200
committerLouis Burda <quent.burda@gmail.com>2024-08-19 18:44:47 +0200
commit18b530e83a74f0a6900b1902abe9aa19823a1cf1 (patch)
tree66f32c941823a67c1088dc857f06b04a9223faf7
parentc9a46c2c0474c7b5bed67519a3df499863db0096 (diff)
downloadsxkbd-master.tar.gz
sxkbd-master.zip
Update READMEHEADmaster
-rw-r--r--README11
-rw-r--r--README.md17
2 files changed, 17 insertions, 11 deletions
diff --git a/README b/README
deleted file mode 100644
index 59b86b4..0000000
--- a/README
+++ /dev/null
@@ -1,11 +0,0 @@
-sxkbd
-=====
-
-Firmware for Corne-LP split keyboard using Blok microcontrollers from Boardsource.
-
-setup
------
-
-To allow full-duplex communication between the halves, the tip pin
-of the TRS connector needs to be connected to GPIO0.
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d4c44b3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+SXKBD Keyboard
+==============
+
+Custom [corne](https://github.com/foostan/crkbd)-style split keyboard (firmware)
+based on RP2040 microcontrollers.
+
+
+Features
+--------
+
+- Multi- and stacked layer + macro support.
+
+- Event-based communication between halves.
+
+- Debug console & logging via USB CDC.
+
+- Clean and simple code.