summaryrefslogtreecommitdiffstats
path: root/keyboards/studiokestra/nue/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-03-04 01:02:37 +0000
committerQMK Bot <hello@qmk.fm>2021-03-04 01:02:37 +0000
commitd3092ced99b5a529c6bde32d8f352cc40abd317d (patch)
tree707d06ae437f088fe77e62b630a5bc9cdcf89d9b /keyboards/studiokestra/nue/readme.md
parent6c3af2670e41448432052a44b446c1c7ff3da9a5 (diff)
parent7aa74c227b03e882915b184d07a5e31c9d720710 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/studiokestra/nue/readme.md')
-rw-r--r--keyboards/studiokestra/nue/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/studiokestra/nue/readme.md b/keyboards/studiokestra/nue/readme.md
new file mode 100644
index 0000000000..42e72902e4
--- /dev/null
+++ b/keyboards/studiokestra/nue/readme.md
@@ -0,0 +1,23 @@
+# Nue
+
+60% PCB with gasket mounting tabs designed for the Nue keyboard.
+
+* Keyboard Maintainer: [Studio Kestra](https://github.com/studiokestra/)
+* Hardware Supported: [studiokestra.ca/nue](https://studiokestra.ca/nue/)
+* Hardware Availability: Group-Buy (Q1 2021)
+
+## Bootload Sequence
+
+There are 3 ways to put the board in bootloader mode:
+
+- Hold the top-left key (typically `Esc`) while plugging in the USB cable, OR
+- While the PCB is plugged into the PC, press the physical `RESET` button on the back of the board, OR
+- With the default layout, toggle Layer 1 and press the `R` key.
+
+## Compiling Firmware
+
+Make example for this keyboard (after setting up your build environment):
+
+ make studiokestra/nue: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).