summaryrefslogtreecommitdiffstats
path: root/keyboards/alf/x2/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2021-09-24 16:29:58 +0000
committerGitHub <noreply@github.com>2021-09-24 09:29:58 -0700
commit60b13d04cdf4b27f387be90d830dd196c38b1362 (patch)
tree88b6ab367241b8f5e93427ef6f5b6de03e736663 /keyboards/alf/x2/readme.md
parent076a332613229110bb39d572f5b342306d380a74 (diff)
Alf X2 Refactor (#14572)
Diffstat (limited to 'keyboards/alf/x2/readme.md')
-rw-r--r--keyboards/alf/x2/readme.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/keyboards/alf/x2/readme.md b/keyboards/alf/x2/readme.md
index b171b5c793..671155a341 100644
--- a/keyboards/alf/x2/readme.md
+++ b/keyboards/alf/x2/readme.md
@@ -4,12 +4,18 @@
A customizable 60% keyboard.
-Keyboard Maintainer: QMK Community
-Hardware Supported: ALF X2 60%
-Hardware Availability: [zFrontier](https://en.zfrontier.com/products/group-buy-alf-x2-60)
+* Keyboard Maintainer: [The QMK Community](https://github.com/qmk)
+* Hardware Supported: ALF X2 60%
+* Hardware Availability: [zFrontier](https://en.zfrontier.com/products/group-buy-alf-x2-60)
Make example for this keyboard (after setting up your build environment):
make alf/x2:default
+Flashing example for this keyboard:
+
+ make alf/x2:default:flash
+
+To reset the board into bootloader mode, hold Space+B while plugging it in.
+
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).