summaryrefslogtreecommitdiff
path: root/keyboards/ibm/model_m/modelm/readme.md
diff options
context:
space:
mode:
authornuess0r <nussgipfel@brain4free.org>2023-05-27 15:12:36 +0200
committerGitHub <noreply@github.com>2023-05-27 23:12:36 +1000
commitf98f8eedf0dc6fe939162210ad44d5af8a0dfa08 (patch)
tree171b1de71a2fec4e7c4f30b6c7e0275061a8d3f3 /keyboards/ibm/model_m/modelm/readme.md
parente759230706373e9db8a0d6758f8c210288870d9f (diff)
Consolidate modelm v2 (#14996)
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Nick Brassel <nick@tzarc.org>
Diffstat (limited to 'keyboards/ibm/model_m/modelm/readme.md')
-rw-r--r--keyboards/ibm/model_m/modelm/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/ibm/model_m/modelm/readme.md b/keyboards/ibm/model_m/modelm/readme.md
new file mode 100644
index 0000000000..048b02495a
--- /dev/null
+++ b/keyboards/ibm/model_m/modelm/readme.md
@@ -0,0 +1,24 @@
+# IBM Model M
+
+This is the parent directory for all projects that replace the controller
+of IBM's Model M Keyboard and then run QMK on it.
+
+These controllers differ in their use of microcontrollers, connection (mainly
+USB) optional speakers etc.
+
+Some of them can be bought fully assembled others are do-it-yourself.
+
+## Warning - Model M Variants
+
+**Not all of these projects will fit into your keyboard!**
+
+As the Model M was produced over several years there are many variants of the
+controller PCB. Check what fits your keyboard before you build/order one.
+
+The variants built for PCs differ in:
+* PCB size
+* Connectors (8/12 pin flex, location)
+* Ground wire connector location
+
+Additionally IBM built Model M variants for terminals with 122 keys, the
+space saving keyboard (SSK, 84-key) etc.