diff options
| author | Steven Karrmann | 2024-02-12 02:26:22 +0100 |
|---|---|---|
| committer | GitHub | 2024-02-12 02:26:22 +0100 |
| commit | cfe8c4dee3599335ec21117b1eb16839934878cd (patch) | |
| tree | 03d0f0b2348ecffc547a86db9c68bb347deddcf3 /keyboards/sha/readme.md | |
| parent | 45ae4dec4d3e8ab0b52903c5ad72b561bd25d94d (diff) | |
Add Sha keyboard (#22664)
* Implement Sha keyboard with default layout
* Adjust readme and info.json per PR checklist
* Fix RGB Light description in default keymap readme
* Update keyboards/sha/rules.mk
Move configuration to info.json
Co-authored-by: Joel Challis <git@zvecr.com>
* Update keyboards/sha/info.json
Move configuration to info.json
Co-authored-by: Joel Challis <git@zvecr.com>
* Update keyboards/sha/info.json
Move configuration to info.json
Co-authored-by: Joel Challis <git@zvecr.com>
* Update keyboards/sha/info.json
Define RGB animations in info.json
Co-authored-by: Joel Challis <git@zvecr.com>
* Enable RGB Lighting Layers at keymap level, not keyboard level
---------
Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'keyboards/sha/readme.md')
| -rw-r--r-- | keyboards/sha/readme.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/sha/readme.md b/keyboards/sha/readme.md new file mode 100644 index 0000000000..ac1b1d970c --- /dev/null +++ b/keyboards/sha/readme.md @@ -0,0 +1,27 @@ +# Sha + + + +Sha is a 50 key ortholinear keyboard, powered by a Waveshare RP2040-Zero or Waveshare RP2040-Matrix. + +* Keyboard Maintainer: [Steven Karrmann](https://github.com/skarrmann) +* Hardware Supported: Sha PCBs with either RP2040-Zero or RP2040-Matrix +* Hardware Availability: [Sha GitHub repository](https://github.com/skarrmann/sha) + +Make example for this keyboard (after setting up your build environment): + + make sha:default + +Flashing example for this keyboard: + + make sha: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 (the top left key) and plug in the keyboard. +* **Physical reset button**: Doublet-tap the EN/RESET button on the MCU board. +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available. |