summaryrefslogtreecommitdiffstats
path: root/keyboards/pearlboards/pearl/readme.md
diff options
context:
space:
mode:
authorKoobaczech <67293963+Koobaczech@users.noreply.github.com>2021-12-23 16:43:10 -0500
committerGitHub <noreply@github.com>2021-12-23 13:43:10 -0800
commite804e28e8e54d6821737fc32f31b7f2735a5994d (patch)
tree37132ded22bfc08dde8a5d0e936dba2bec6533c0 /keyboards/pearlboards/pearl/readme.md
parente9d1a711b457e5f7a9af6f2feb37e4be8e84e96d (diff)
[Keyboard] Add Pearlboards boards to directory (#15005)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/pearlboards/pearl/readme.md')
-rw-r--r--keyboards/pearlboards/pearl/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/pearlboards/pearl/readme.md b/keyboards/pearlboards/pearl/readme.md
new file mode 100644
index 0000000000..7679b270b3
--- /dev/null
+++ b/keyboards/pearlboards/pearl/readme.md
@@ -0,0 +1,22 @@
+# Pearl
+
+![Pearl](https://i.imgur.com/xdEtT7uh.jpg)
+
+Pearl is a future-proof premium 40%. This is the second round of it, reworked for 2021. This firmware is for the latest QMK PCB's.
+
+* Keyboard Maintainer: Koobaczech
+* Hardware Supported: Pearl
+* Availability: https://pearlboards.net/products/pearl-40
+
+Make example for this keyboard (after setting up your build environment):
+
+ make pearlboards/pearl:default
+
+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 2 ways:
+
+* **Physical reset button**: Briefly press the button on the front left of the PCB labeled "RESET"
+* **Keycode in layout**: Press the key mapped to `RESET` in conjunction with the key mapped to `MO(1))`