diff options
| author | QMK Bot <hello@qmk.fm> | 2021-07-01 07:45:16 +0000 |
|---|---|---|
| committer | QMK Bot <hello@qmk.fm> | 2021-07-01 07:45:16 +0000 |
| commit | 425c0dad010b29b137c875afd2122bd9cd0e78af (patch) | |
| tree | 338089ac142abe239bd17e089921bbce371b9351 /keyboards/pteron36/readme.md | |
| parent | 29228e5b78ce151180dcea57e14b8f9fa26d11bb (diff) | |
| parent | 4168e10c49d512132db369fcc3402e56052cebd1 (diff) | |
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/pteron36/readme.md')
| -rw-r--r-- | keyboards/pteron36/readme.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/pteron36/readme.md b/keyboards/pteron36/readme.md new file mode 100644 index 0000000000..b9e919c756 --- /dev/null +++ b/keyboards/pteron36/readme.md @@ -0,0 +1,31 @@ +# Pteron36 + + + +A 36 key keyboard with a bit more natural thumb cluster. + +* Keyboard Maintainer: [Harshit Goel](https://github.com/harshitgoel96) +* Hardware Supported: Pteron36 using promicro. +* Hardware Availability: Hardware is opensource, you can simply send the gerber to a PCB manufacturere and them made. File are availalbe in [pteron36 repository](https://github.com/harshitgoel96/pteron36-split-keyboard/releases/tag/v1.2.0) + +Make example for this keyboard (after setting up your build environment): + + make pteron36:default + +Flashing example for this keyboard: + + make pteron36: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). + +## Default Keymap and Miryoku Layout support + +The keyboard was designed with miryoku layout in mind. The default layout is very basic and does not have much use. I will be opening a pr to make the keyboard available with miryoku layout soon. Currently to build the keyboard with miryoku you will have to checkout latest miryoku qmk repo, and add the keyboard folder there manually. After copying the folder run the following command + + make pteron36:manna-harbour_miryoku + +Add miryoku params as required. + +## OLED and RotaryEncoder + +I am working on adding OLED and RotaryEncoder support in keyboard config. |