summaryrefslogtreecommitdiff
path: root/keyboards/handwired/swiftrax/koalafications/readme.md
diff options
context:
space:
mode:
authorBrandon Claveria <48102030+swiftrax@users.noreply.github.com>2021-02-03 11:54:30 -0800
committerGitHub <noreply@github.com>2021-02-03 11:54:30 -0800
commitfaa6c93648f4fc6a538a66478f646aef6661894f (patch)
tree4ff8dca5ff7cdded8109295fa60a41ff3d633593 /keyboards/handwired/swiftrax/koalafications/readme.md
parent4779e2d56c6c43e21c6c31c9f1aed280f097ea10 (diff)
[Keyboard] add koalafications (#11628)
* add koalafications * fix keymap * add oled * oled stuff * fix oled stuff * add animation * more oled stuff * update rules.mk * oled annimation * change PID * Update keyboards/handwired/swiftrax/koalafications/info.json * Update keyboards/handwired/swiftrax/koalafications/readme.md
Diffstat (limited to 'keyboards/handwired/swiftrax/koalafications/readme.md')
-rw-r--r--keyboards/handwired/swiftrax/koalafications/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/handwired/swiftrax/koalafications/readme.md b/keyboards/handwired/swiftrax/koalafications/readme.md
new file mode 100644
index 0000000000..7511ba12fb
--- /dev/null
+++ b/keyboards/handwired/swiftrax/koalafications/readme.md
@@ -0,0 +1,21 @@
+# Koalafications
+
+Basic 75% with oled
+
+* Keyboard Maintainer: Swiftrax
+* Hardware Supported: Koalafications
+* Hardware Availability: https://github.com/swiftrax
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/swiftrax/koalafications:default
+
+Flashing example for this keyboard:
+
+ make handwired/swiftrax/koalafications:default:flash
+
+## Accessing Bootloader Mode
+
+To access Bootloader Mode, hold the key at the top left of the keyboard while connecting the USB cable (also erases persistent settings).
+
+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).