summaryrefslogtreecommitdiffstats
path: root/keyboards/phantom/readme.md
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2020-11-02 20:23:54 +1100
committerGitHub <noreply@github.com>2020-11-02 20:23:54 +1100
commit8e71d3d053949593d02a3c1852fd1993d2e3f573 (patch)
treea17bc585db080b0845ef67d8986165cf09cd027e /keyboards/phantom/readme.md
parente69da2db2c59a8017f0c9dee9933dd508d22b356 (diff)
Phantom refactor (#10805)
Diffstat (limited to 'keyboards/phantom/readme.md')
-rw-r--r--keyboards/phantom/readme.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/keyboards/phantom/readme.md b/keyboards/phantom/readme.md
index b25630958b..857525d98c 100644
--- a/keyboards/phantom/readme.md
+++ b/keyboards/phantom/readme.md
@@ -1,16 +1,19 @@
-Phantom
-=======
+# Phantom
A community-developed keyboard PCB designed to fit inside the case of a Filco Majestouch.
See the [Deskthority wiki](https://deskthority.net/wiki/Phantom) for more information.
-Keyboard Maintainer: QMK Community
-Hardware Supported: Phantom PCB
-Hardware Availability: https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=536
+* Keyboard Maintainer: QMK Community
+* Hardware Supported: Phantom PCB
+* Hardware Availability: https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=536
Make example for this keyboard (after setting up your build environment):
make phantom: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.
+Flashing example for this keyboard:
+
+ make phantom:default:flash
+
+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).