diff options
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 000000000..6358bc754 --- /dev/null +++ b/keyboards/xd002/readme.md | |||
| @@ -0,0 +1,49 @@ | |||
| 1 | # xd002 | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | 2% Custom mechanical keyboard. ATtiny85 powered, with 2*WS2812 LEDs, and the micronucleus bootloader. | ||
| 6 | |||
| 7 | **Note**: Due to limited firmware space, a _**lot**_ of features have to be disabled to get a functioning QMK based keyboard. | ||
| 8 | |||
| 9 | * Keyboard Maintainer: [zvecr](https://github.com/zvecr) | ||
| 10 | * Hardware Supported: xd002 | ||
| 11 | * 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) | ||
| 12 | |||
| 13 | Make example for this keyboard (after setting up your build environment): | ||
| 14 | |||
| 15 | make xd002:default | ||
| 16 | |||
| 17 | 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). | ||
| 18 | |||
| 19 | ## Flashing | ||
| 20 | ### Prerequisites | ||
| 21 | |||
| 22 | ```bash | ||
| 23 | git clone https://github.com/micronucleus/micronucleus.git | ||
| 24 | cd micronucleus/commandline/ | ||
| 25 | sudo make install | ||
| 26 | ``` | ||
| 27 | |||
| 28 | 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: | ||
| 29 | |||
| 30 | ```bash | ||
| 31 | sudo udevadm control --reload-rules | ||
| 32 | sudo udevadm trigger | ||
| 33 | ``` | ||
| 34 | |||
| 35 | ### Instructions | ||
| 36 | |||
| 37 | **Reset Key**: Hold down key nearest to the USB socket while plugging in the keyboard. | ||
| 38 | |||
| 39 | ```bash | ||
| 40 | make xd002:default:flash | ||
| 41 | |||
| 42 | # or directly with... | ||
| 43 | micronucleus --run <firmware.hex> | ||
| 44 | ``` | ||
| 45 | |||
| 46 | ### Recovery | ||
| 47 | |||
| 48 | * [Original Firmware](https://github.com/xiudi/Attiny85_vusb_pad_test) | ||
| 49 | * [Bootloader Repair](https://digistump.com/wiki/digispark/tutorials/proisp) | ||
