diff options
author | peepeetee <43021794+peepeetee@users.noreply.github.com> | 2021-08-21 22:53:49 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-08-22 13:53:49 +1000 |
commit | 78ccd9c201199444bc06161b05ee8d7ba9c31613 (patch) | |
tree | 726d9e55d8cde510fe72bc1fb9bb2a7dabdbecc2 /keyboards/xiudi/xd002/readme.md | |
parent | c70abc8d047319830e369ae4e14cd43bae3bd3b8 (diff) |
Organize KPrepublic, K.T.E.C, xiudi boards into directories (#12159)
* reset; redoing my steps; and recommit
* include xd002/.noci
Diffstat (limited to 'keyboards/xiudi/xd002/readme.md')
-rw-r--r-- | keyboards/xiudi/xd002/readme.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/keyboards/xiudi/xd002/readme.md b/keyboards/xiudi/xd002/readme.md new file mode 100644 index 0000000000..6358bc754e --- /dev/null +++ b/keyboards/xiudi/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) |