summaryrefslogtreecommitdiff
path: root/keyboards/chalice/readme.md
diff options
context:
space:
mode:
authorJosh Johnson <josh@joshajohnson.com>2021-11-13 03:37:54 +1100
committerGitHub <noreply@github.com>2021-11-12 08:37:54 -0800
commit051bde9c63cbfa5c5fbebc53daa59ce30fb0cebd (patch)
treed72e4b82fc38459017e3277bd0ea0e1c6871b65b /keyboards/chalice/readme.md
parent7c2b2c81b53d055c66a15bd9ced92f548ca28ad6 (diff)
[Keyboard] Add Chalice Support (#15106)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/chalice/readme.md')
-rw-r--r--keyboards/chalice/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/chalice/readme.md b/keyboards/chalice/readme.md
new file mode 100644
index 0000000000..ebfaa3cbd1
--- /dev/null
+++ b/keyboards/chalice/readme.md
@@ -0,0 +1,25 @@
+# Chalice
+
+A Cheap Alice, powered by a Pro-Micro
+
+* Keyboard Maintainer: [CustomKBD](https://github.com/customkbd/)
+* Hardware Supported: Pro-Micro (or equivalent - Sea Micro, Elite-C etc.)
+* Hardware Availability: [CustomKBD](https://customkbd.com/products/chalice-pre-order)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make chalice:default
+
+Flashing example for this keyboard:
+
+ make chalice:default:flash
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down Escape and plug in the keyboard.
+* **Physical reset button**: Briefly press the reset button below the pro-micro.
+* **Keycode in layout**: The `RESET` key can be found by holding `FUNC` in between the space bars and pressing `ESC`.
+
+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).