Update README.md

This commit is contained in:
Cai Maver 2023-02-27 19:39:16 -08:00 committed by GitHub
parent 4d71b65717
commit 74c36be27d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,6 +1,6 @@
# Piantor
The [Piantor, created by Leo Lou](https://github.com/beekeeb/piantor), is a 36- or 42-key staggered column, diodeless keyboard . It is based on the [Cantor by Diego Palacios](https://github.com/diepala/cantor), but uses a Raspberry Pi Pico as the controller.
The [Piantor by beekeeb](https://github.com/beekeeb/piantor), is a 36- or 42-key staggered column, diodeless keyboard. It is based on the [Cantor by Diego Palacios](https://github.com/diepala/cantor), but uses a Raspberry Pi Pico as the controller.
The default keymap replicates the Corne/crkbd default keymap by foostan and drashna.
@ -9,4 +9,4 @@ Purchase: [BeeKeeb](https://shop.beekeeb.com/product/piantor-keyboard-kit/)
## Microcontroller and Split Support
This firmware assumes that VBUS will be used for split side detection as in the QMK implementation. This requires that the USB cable is plugged into the left side to ensure that the correct pin mapping is used. If using a rp2040 microcontroller without a VBus sense circuit (like the WeAct RP2040), resistors must be soldered to the bottom of the PCBs, and you will need to uncomment line 9 of kb.py to assign the VBus sense pin to GP24.
An alternative option is to detect the split sides using the drive names. See the KMK documentation for setting this up. Once you have set drive names, you can comment out lines 12-14 and uncomment lines 17-18 in kb.py to enable this option.
An alternative option is to detect the split sides using the drive names. See the [KMK documentation](http://kmkfw.io/docs/split_keyboards#drive-names) for setting this up. Once you have set drive names, you can comment out lines 12-14 and uncomment lines 17-18 in kb.py to enable this option.