summaryrefslogtreecommitdiff
path: root/keyboards/controllerworks/city42/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/controllerworks/city42/readme.md')
-rw-r--r--keyboards/controllerworks/city42/readme.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/controllerworks/city42/readme.md b/keyboards/controllerworks/city42/readme.md
new file mode 100644
index 0000000000..7dc382bffc
--- /dev/null
+++ b/keyboards/controllerworks/city42/readme.md
@@ -0,0 +1,31 @@
+# city42
+![city42](https://i.imgur.com/YZNW4EZh.jpg)
+*A pre-built, low profile, unibody split keyboard based on the RP2040 processor*
+* Keyboard Maintainer: [Kevin Gee](https://github.com/controller-works)
+* Hardware Supported: *city42 split unibody ergonomic keyboard*
+* Hardware Availability: *[Controller Works Retail Site](https://controller.works/products/city42-ergonomic-keyboard)* Hardware is available as pre-built units only.
+Make example for this keyboard (after setting up your build environment):
+```sh
+ make controllerworks/city42:default
+```
+Flashing example for this keyboard:
+
+```sh
+ make controllerworks/city42:default:flash
+```
+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).
+## Features
+- Highly integrated design with microcontroller and USB connectors on the main board
+- RP2040 processor by Raspberry Pi Foundation running at 130 MHz with 16MB flash memory
+- 40mm Cirque trackpad
+- 42 per-key RGB LEDs
+- ESD and over-current protection on USB
+- Reset and boot tactile switches
+- USB C host connection
+- Hot swap connectors for Kailh Chocolate PG1350 switches
+- Chocolate key spacing (18mm horizontal x 17mm vertical)
+## Bootloader
+Enter the bootloader in 3 ways:
+* **Bootmagic reset**: Hold down the upper left key while plugging in USB
+* **Physical reset button**: Press the RST button twice, rapidly
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available