diff options
| author | Uy Bui <uybv.cntt@gmail.com> | 2021-09-10 02:02:45 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-09 10:02:45 -0700 |
| commit | 22499636871ae8f0b8f2da90f801f9290fb1d186 (patch) | |
| tree | c37c4947b734ed476120fe272f1017ce3a9af390 /keyboards/wekey/polaris/readme.md | |
| parent | d6dd2e0d516a67bdc9bde2b6d1680a00c48675e4 (diff) | |
[Keyboard] Add custom pcb for Polaris (#14347)
* [Keyboard] pcb for Polaris
* [Keyboard] pcb for Polaris: update layout
* Update keyboards/wekey/polaris/info.json
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/wekey/polaris/readme.md')
| -rw-r--r-- | keyboards/wekey/polaris/readme.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/wekey/polaris/readme.md b/keyboards/wekey/polaris/readme.md new file mode 100644 index 0000000000..40fcf65bb6 --- /dev/null +++ b/keyboards/wekey/polaris/readme.md @@ -0,0 +1,27 @@ +# polaris + + + +A customizable pcb for Polaris. + +* Keyboard Maintainer: [@wekey](https://github.com/wekey-dev) +* Hardware Supported: Polaris case +* Hardware Availability: custom pcb group buys + +Make example for this keyboard (after setting up your build environment): + + make polaris:default + +Flashing example for this keyboard: + + make polaris: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 `RESET` if it is available |