diff options
| author | Joel Challis <git@zvecr.com> | 2020-05-01 17:59:22 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-01 17:59:22 +0100 |
| commit | f7324ec68494026c27b9c4af4b34bf4a98d2c75b (patch) | |
| tree | ce303538e8eed3d667ef5097eb7b279ad3030e77 /keyboards/xd002/readme.md | |
| parent | 750c7c2bdbfb4b4e9d3a9efe6cb3f95ef0b43c53 (diff) | |
Add xd002 support (#8598)
* Add xd002 support
* tidy some whitespace
* align filename
* Update keyboards/xd002/info.json
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Diffstat (limited to 'keyboards/xd002/readme.md')
| -rw-r--r-- | keyboards/xd002/readme.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/keyboards/xd002/readme.md b/keyboards/xd002/readme.md new file mode 100644 index 0000000000..6358bc754e --- /dev/null +++ b/keyboards/xd002/readme.md @@ -0,0 +1,49 @@ +# xd002 + + + +2% Custom mechanical keyboard. ATtiny85 powered, with 2*WS2812 LEDs, and the micronucleus bootloader. + +**Note**: Due to limited firmware space, a _**lot**_ of features have to be disabled to get a functioning QMK based keyboard. + +* Keyboard Maintainer: [zvecr](https://github.com/zvecr) +* Hardware Supported: xd002 +* Hardware Availability: [kprepublic](https://kprepublic.com/products/xd002-xiudi-2-custom-mechanical-keyboard-2-keys-underglow-and-switch-rgb-pcb-programmed-hot-swappable-macro-key-aluminum-case) + +Make example for this keyboard (after setting up your build environment): + + make xd002:default + +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). + +## Flashing +### Prerequisites + +```bash +git clone https://github.com/micronucleus/micronucleus.git +cd micronucleus/commandline/ +sudo make install +``` + +On Linux, you’ll need proper privileges to access the MCU. You can either use sudo when flashing firmware, or place [these files](https://github.com/micronucleus/micronucleus/blob/master/commandline/49-micronucleus.rules) in /etc/udev/rules.d/. Once added run the following: + +```bash +sudo udevadm control --reload-rules +sudo udevadm trigger +``` + +### Instructions + +**Reset Key**: Hold down key nearest to the USB socket while plugging in the keyboard. + +```bash +make xd002:default:flash + +# or directly with... +micronucleus --run <firmware.hex> +``` + +### Recovery + +* [Original Firmware](https://github.com/xiudi/Attiny85_vusb_pad_test) +* [Bootloader Repair](https://digistump.com/wiki/digispark/tutorials/proisp) |