diff options
Diffstat (limited to 'keyboards/jj40/README.md')
| -rw-r--r-- | keyboards/jj40/README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/keyboards/jj40/README.md b/keyboards/jj40/README.md new file mode 100644 index 0000000000..6b48c15159 --- /dev/null +++ b/keyboards/jj40/README.md @@ -0,0 +1,50 @@ +# jj40 + + + +A compact 40% (12x4) ortholinear keyboard kit made and KPRepublic on AliExpress. + +Keyboard Maintainer: [QMK Community](https://github.com/qmk) +Hardware Supported: Atmega32A +Hardware Availability: [AliExpress](https://www.aliexpress.com/store/product/jj40-Custom-Mechanical-Keyboard-40-PCB-programmed-40-planck-layouts-bface-firmware-gh40/3034003_32828781103.html) + +Make example for this keyboard (after setting up your build environment): + + make jj40-program + +See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. + +Note that this is a complete replacement for the firmware, so you won't be +using Bootmapper Client to change any keyboard settings, since not all the +USB report options are supported. + +In addition you may need the AVR toolchain and `bootloadHID` for flashing: + +``` +$ brew cask install crosspack-avr +$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb +``` + +In order to use the `./program` script, which can reboot the board into +the bootloader, you'll need Python 2 with PyUSB installed: + +``` +$ pip install pyusb +``` + +If you prefer, you can just build it and flash the firmware directly with +`bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it +in the bootloader: + +``` +$ make jj40 +$ bootloadHID -r jj40_default.hex +``` + +## Troubleshooting + +1. Try plugging the board in while pressing `L_Ctrl`. This will force it + to boot only the bootloader without loading the firmware. Once this is + done, just reflash the board with the original firmware. +2. Sometimes USB hubs can act weird, so try connecting the board directly + to your computer or plugging/unplugging the USB hub. |