summaryrefslogtreecommitdiff
path: root/keyboards/4pplet/unextended_std/readme.md
diff options
context:
space:
mode:
author4pplet <mail@4pplet.com>2023-04-03 07:24:49 +0200
committerGitHub <noreply@github.com>2023-04-03 15:24:49 +1000
commit8a5e8ed88e818e2a4ccd1349ea63cb35042e674f (patch)
tree304972be535662d797a393aa6da9fa563de3e5bf /keyboards/4pplet/unextended_std/readme.md
parentfb6557acf1c5b3753034f8d25e738ae964ea0215 (diff)
Adding Unextended Standard PCB (#20190)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: 4pplet <4pplet@protonmail.com> Co-authored-by: 4pplet <stefan.ess@gmail.com>
Diffstat (limited to 'keyboards/4pplet/unextended_std/readme.md')
-rw-r--r--keyboards/4pplet/unextended_std/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/4pplet/unextended_std/readme.md b/keyboards/4pplet/unextended_std/readme.md
new file mode 100644
index 0000000000..2d276511ed
--- /dev/null
+++ b/keyboards/4pplet/unextended_std/readme.md
@@ -0,0 +1,23 @@
+# Unextended Standard PCB
+
+PCB for the Unextended Standard Project. The PCB enables use of M0116, M0118, IIc and NeXT keycaps and is designed to fit in the open sourced Unextended case.
+
+* Keyboard Maintainer: [4pplet](https://github.com/4pplet)
+* Hardware Supported: [Unextended Standard PCB](https://github.com/4pplet/Unextended-Standard-PCB)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make 4pplet/unextended_std/rev_a:default
+
+Flashing example for this keyboard:
+
+ make 4pplet/unextended_std/rev_a: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 Escape-key and plug in the keyboard
+* **Physical reset header**: Briefly short the header labled "BL/reset" on the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available