[Keyboard] Snagpad Configurator bugfix and readme refactor (#6381)

[qmk_firmware.git] / keyboards / whitefox / readme.md

diff --git a/keyboards/whitefox/readme.md b/keyboards/whitefox/readme.md
index 0714ad5639762052c1171ae85953955ef55142d7..9b848a69d5dc3c0784ac8e1b66b65847426116b2 100644 (file)
--- a/keyboards/whitefox/readme.md
+++ b/keyboards/whitefox/readme.md
@@ -1,7 +1,13 @@
-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/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.