summaryrefslogtreecommitdiffstats
path: root/keyboards/studiokestra/bourgeau/readme.md
diff options
context:
space:
mode:
authorstudiokestra <74369928+studiokestra@users.noreply.github.com>2021-11-15 16:44:17 -0700
committerGitHub <noreply@github.com>2021-11-15 15:44:17 -0800
commit269990ed95f80db2349661b2731b42501e3b2803 (patch)
treeffbb5bdd726e4cf974e9249f811142d957065e77 /keyboards/studiokestra/bourgeau/readme.md
parent0db70f1f2a397e1e8a298f8add9a47dca09c7c55 (diff)
[Keyboard] Add Bourgeau 75% PCB (#15072)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/studiokestra/bourgeau/readme.md')
-rw-r--r--keyboards/studiokestra/bourgeau/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/studiokestra/bourgeau/readme.md b/keyboards/studiokestra/bourgeau/readme.md
new file mode 100644
index 0000000000..16f87618e0
--- /dev/null
+++ b/keyboards/studiokestra/bourgeau/readme.md
@@ -0,0 +1,23 @@
+# Bourgeau
+
+Compact 75% universal hotswap PCB with USB-C that supports a fixed 6.25U bottom row layout.
+
+* Keyboard Maintainer: [Studio Kestra](https://github.com/studiokestra/)
+* Hardware Supported: PLA75
+* Hardware Availability: [RNDKBD.com](https://rndkbd.com/)
+
+## 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 `ESC` key.
+
+## Compiling Firmware
+
+Make example for this keyboard (after setting up your build environment):
+
+ make studiokestra/bourgeau: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).