summaryrefslogtreecommitdiff
path: root/keyboards/whitefox
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/whitefox')
-rw-r--r--keyboards/whitefox/readme.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/keyboards/whitefox/readme.md b/keyboards/whitefox/readme.md
index 0714ad5639..2f1445d33d 100644
--- a/keyboards/whitefox/readme.md
+++ b/keyboards/whitefox/readme.md
@@ -1,7 +1,14 @@
-WhiteFox keyboard firmware
-======================
+WhiteFox
+========
-This is an experimental port which came from the original TMK WhiteFox repo.
+A compact 65% keyboard.
-The LED controller was not ported, as the original was a dirty hack and it would
-be good to have complete support.
+Keyboard Maintainer: QMK Community
+Hardware Supported: Whitefox PCB
+Hardware Availability: https://input.club/whitefox/
+
+Make example for this keyboard (after setting up your build environment):
+
+ make whitefox-default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.