aboutsummaryrefslogtreecommitdiff
path: root/keyboards/kiwikey/borderland/readme.md
diff options
context:
space:
mode:
authorKiwiKey <[email protected]>2021-12-18 09:29:48 +0700
committerGitHub <[email protected]>2021-12-17 18:29:48 -0800
commit4b9ba0dcc5cb708c6197aca941da6248b896aa2b (patch)
tree65980baea3831d076190730a2898815a12c5a148 /keyboards/kiwikey/borderland/readme.md
parent69527be90b3ea40368739517b6cb979364ce4d58 (diff)
downloadqmk_firmware-4b9ba0dcc5cb708c6197aca941da6248b896aa2b.tar.gz
qmk_firmware-4b9ba0dcc5cb708c6197aca941da6248b896aa2b.zip
[Keyboard] Add Borderland (#15501)
Co-authored-by: Drashna Jaelre <[email protected]>
Diffstat (limited to 'keyboards/kiwikey/borderland/readme.md')
-rw-r--r--keyboards/kiwikey/borderland/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/kiwikey/borderland/readme.md b/keyboards/kiwikey/borderland/readme.md
new file mode 100644
index 0000000000..98f76e0f13
--- /dev/null
+++ b/keyboards/kiwikey/borderland/readme.md
@@ -0,0 +1,27 @@
+# Borderland
+
+![Borderland](https://i.imgur.com/3aMyUJb.jpg)
+
+Another keyboard with well-known Arisu layout, comes with USB Type-C connection and Rotary Encoder. More information can be found at https://kiwikey.vn/borderland/
+
+* Keyboard Maintainer: [KiwiKey](https://github.com/kiwikey)
+* Hardware Supported: Borderland PCB rev1
+* Hardware Availability: [KiwiKey Website](https://kiwikey.vn/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kiwikey/borderland:default
+
+Flashing example for this keyboard:
+
+ make kiwikey/borderland: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).
+
+## 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**: Briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `RESET`, in default keymap it is `Fn+R`