aboutsummaryrefslogtreecommitdiff
path: root/keyboards/eggsworks/egg58/readme.md
diff options
context:
space:
mode:
authorTravis Mick <[email protected]>2023-06-06 01:03:57 -0600
committerGitHub <[email protected]>2023-06-06 00:03:57 -0700
commitdd9712c40e91396fb0efbf23360a2025c0a5893e (patch)
tree5a80d3666599c9acce5b372f02be5b5a98d195bf /keyboards/eggsworks/egg58/readme.md
parent97014f07225a32185231d561b8c0795b50f8484d (diff)
downloadqmk_firmware-dd9712c40e91396fb0efbf23360a2025c0a5893e.tar.gz
qmk_firmware-dd9712c40e91396fb0efbf23360a2025c0a5893e.zip
[Keyboard] Add egg58 (#21021)
Diffstat (limited to 'keyboards/eggsworks/egg58/readme.md')
-rw-r--r--keyboards/eggsworks/egg58/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/eggsworks/egg58/readme.md b/keyboards/eggsworks/egg58/readme.md
new file mode 100644
index 0000000000..fe9b1819ee
--- /dev/null
+++ b/keyboards/eggsworks/egg58/readme.md
@@ -0,0 +1,23 @@
+# egg58
+
+* Keyboard Maintainer: [Travis Mick](https://github.com/tmick0)
+* Hardware Supported: egg58 (v1-v2.x) PCB, with Pro Micro or compatible MCU
+* Hardware Availability: https://eggs.works/ or https://github.com/eggsworks/egg58
+
+Make example for this keyboard (after setting up your build environment):
+
+ make eggsworks/egg58:default
+
+Flashing example for this keyboard:
+
+ make eggsworks/egg58: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 - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available