summaryrefslogtreecommitdiff
path: root/keyboards/1k/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-04-19 10:40:23 +0000
committerQMK Bot <hello@qmk.fm>2022-04-19 10:40:23 +0000
commiteab3be1e756d701bb3af2d7c8fe152a8be427806 (patch)
tree19220ddcfa4c88bf558d330ee29480f312e95989 /keyboards/1k/readme.md
parent571935324007b77e86a013d4d7ea6c9e87076593 (diff)
parentbdd1f318c3f4bcbf7f9dfeaff908013780bf753a (diff)
downloadqmk_firmware-eab3be1e756d701bb3af2d7c8fe152a8be427806.tar.gz
qmk_firmware-eab3be1e756d701bb3af2d7c8fe152a8be427806.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/1k/readme.md')
-rw-r--r--keyboards/1k/readme.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/keyboards/1k/readme.md b/keyboards/1k/readme.md
new file mode 100644
index 0000000000..8c44c3549d
--- /dev/null
+++ b/keyboards/1k/readme.md
@@ -0,0 +1,47 @@
+# 1k
+
+![1k](https://booth.pximg.net/aaeb2dda-e169-44c0-ba5a-5b42cc5c2627/i/3504781/c1708a8a-061b-4a6c-907d-72d0eab47d4a.png)
+
+1% Custom mechanical keyboard. ATtiny85 powered, with 1*WS2812 LED, 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: [MakotoKurauchi](https://github.com/MakotoKurauchi)
+* Hardware Supported: 1k
+* Hardware Availability: [booth](https://ninep.booth.pm/items/3504781)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make 1k: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
+
+```bash
+make 1k: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)