summaryrefslogtreecommitdiff
path: root/keyboards/keycapsss/3w6_2040/readme.md
diff options
context:
space:
mode:
authorTom Barnes <tom@mechboards.co.uk>2023-12-13 19:40:33 +0000
committerGitHub <noreply@github.com>2023-12-13 12:40:33 -0700
commit68afa1ef0644b8000b936e3c43ba7431007a0844 (patch)
tree66302f64e681abeba2dde0581e8241c46ceba9ca /keyboards/keycapsss/3w6_2040/readme.md
parentea56863e32243c52c847729bb8bbcafecb11728c (diff)
[keyboard] Add Keycapsss 3w6_2040 (#22642)
* initial commit * tidy info.json, add readme.md * correct license headers * fix some minor typos * additions to readme * try and conform to standards * remove duplicates from config.h * remove unneccessary line from rules.mk * further tidying * some small misses * some small misses * repair via keymap * actually fixed, d'oh * Update keyboards/keycapsss/3w6_2040/info.json Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/keycapsss/3w6_2040/info.json Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/keycapsss/3w6_2040/keymaps/default/keymap.c Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/keycapsss/3w6_2040/info.json Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/keycapsss/3w6_2040/keymaps/via/keymap.c Co-authored-by: jack <0x6a73@protonmail.com> * Update keyboards/keycapsss/3w6_2040/readme.md Co-authored-by: jack <0x6a73@protonmail.com> * remove via config.h --------- Co-authored-by: jack <0x6a73@protonmail.com>
Diffstat (limited to 'keyboards/keycapsss/3w6_2040/readme.md')
-rw-r--r--keyboards/keycapsss/3w6_2040/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/keycapsss/3w6_2040/readme.md b/keyboards/keycapsss/3w6_2040/readme.md
new file mode 100644
index 0000000000..2c43daa12b
--- /dev/null
+++ b/keyboards/keycapsss/3w6_2040/readme.md
@@ -0,0 +1,29 @@
+# 3w6_2040
+
+![image](https://i.imgur.com/QAL63nyh.jpg)
+
+A split keyboard with 3x5 vertically staggered keys and 3 thumb keys, with support for pimoroni trackball modules on each half.
+
+This version is distinct from keyboards/3w6 and is exclusive to [keycapsss.com](https://keycapsss.com).
+
+* Keyboard Maintainer: [@keyboard-magpie]
+* Hardware Supported: On board rp2040 microcontrollers.
+* Hardware Availability: [keycapsss.com](https://keycapsss.com)
+
+Make firmware .uf2 for this keyboard (after setting up your build environment):
+
+ qmk compile -kb keycapsss/3w6_2040 -km default
+
+Example of flashing this keyboard:
+
+ qmk flash -kb keycapsss/3w6_2040 -km default (or drag and drop the uf2 from the above command into the mass storage device that appears when in bootloader mode)
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Press and hold the button on the front of the PCB when plugging in.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available