aboutsummaryrefslogtreecommitdiff
path: root/keyboards/artemis/paragon/readme.md
diff options
context:
space:
mode:
authorSleepdealr <[email protected]>2023-06-15 00:28:06 -0400
committerGitHub <[email protected]>2023-06-14 22:28:06 -0600
commit66f06a175f13851ae1d3c37a85b1d2d3ffea58b7 (patch)
tree14ef32fa22dd7191ab6f455f8e23476ebef7d98c /keyboards/artemis/paragon/readme.md
parent8f980ea69fcebfc70e716da27907ce13940657a1 (diff)
downloadqmk_firmware-66f06a175f13851ae1d3c37a85b1d2d3ffea58b7.tar.gz
qmk_firmware-66f06a175f13851ae1d3c37a85b1d2d3ffea58b7.zip
[Keyboard] Add Artemis Paragon (#20910)
Co-authored-by: jack <[email protected]>
Diffstat (limited to 'keyboards/artemis/paragon/readme.md')
-rw-r--r--keyboards/artemis/paragon/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/artemis/paragon/readme.md b/keyboards/artemis/paragon/readme.md
new file mode 100644
index 0000000000..287d141ccc
--- /dev/null
+++ b/keyboards/artemis/paragon/readme.md
@@ -0,0 +1,23 @@
+# Artemis/Paragon
+
+* Keyboard Maintainer: [Sleepdealer](https://github.com/Sleepdealr)
+* Hardware Supported: Paragon PCB
+* Hardware Availability: GB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make artemis/paragon/hotswap:default
+
+Flashing example for this keyboard:
+
+ make artemis/paragon/hotswap: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