diff options
| author | Louis Dalibard <louis.dalibard@gmail.com> | 2022-08-21 02:17:02 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-20 17:17:02 -0700 |
| commit | 7ea54a78376aee85a051a49185aa3555e8da41d2 (patch) | |
| tree | 5cf306d02efb6f70e608cd15ebb567a04444f0d6 /keyboards/ai/readme.md | |
| parent | e2fbcc8099212acff389d96b777030e9d0d79e28 (diff) | |
[Keyboard] Add ai macropad (#17722)
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Louis Dalibard <ontake@ontake.dev>
Diffstat (limited to 'keyboards/ai/readme.md')
| -rw-r--r-- | keyboards/ai/readme.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/keyboards/ai/readme.md b/keyboards/ai/readme.md new file mode 100644 index 0000000000..670996640f --- /dev/null +++ b/keyboards/ai/readme.md @@ -0,0 +1,34 @@ +# ai + + + +This is a small open source 5x4-1 macropad powered by QMK + +* Keyboard Maintainer: [Louis Dalibard](https://github.com/make42) +* Hardware Supported: The PCB for ai is located here: [ai](https://github.com/make42/ai) +* Hardware Availability: Here is a complete BOM with links to where you can find parts: + * PCB (I personally used JLCPCB) + * Arduino Pro Micro ([Aliexpress](https://fr.aliexpress.com/item/32768308647.html?spm=a2g0o.order_list.0.0.3ccc5e5bU64POK&gatewayAdapt=glo2fra)) + * Female pin rows ([Aliexpress]https://fr.aliexpress.com/item/4001122376295.html?spm=a2g0o.order_list.0.0.23845e5bTBt8sp&gatewayAdapt=glo2fra)) + * Gateron hotswap sockets ([Aliexpress](https://fr.aliexpress.com/item/1005003129613578.html?spm=a2g0o.order_list.0.0.23845e5bTBt8sp&gatewayAdapt=glo2fra)) + * Zener diodes ([Aliexpress](https://fr.aliexpress.com/item/1005003276184193.html?spm=a2g0o.order_list.0.0.23845e5bTBt8sp&gatewayAdapt=glo2fra)) + * Keyswitches (use a compatible MX switch) + * Keycaps (Duh) + +Make example for this keyboard (after setting up your build environment): + + make ai:default + +Flashing example for this keyboard: + + make ai: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 |