]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/snagpad/readme.md
[Keyboard] Snagpad Configurator bugfix and readme refactor (#6381)
[qmk_firmware.git] / keyboards / snagpad / readme.md
index eeafceba9a7191b2eba9c830db6437c5b14ec093..b59bd758860d9ccdf638b627362e3b33b5511d52 100644 (file)
@@ -1,21 +1,21 @@
 # Snagpad
-QMK for Snagpad
 
-This PCB can be used as a standard numpad, or a ortho 5x4 macropad.
+A five-row PCB that can be built as a standard numpad or an ortholinear 5x4 macropad. Can be built as single PCB with custom case, or as two PCB style with standoffs. Requires a Pro Micro.
 
-For QMK Configurator, the info.json is utilised.
-- For 2U keys on numpad, the first 1u row/column key assignment is the same as the 2u position.
+Keyboard Maintainer: [Flehrad](https://github.com/flehrad)  
+Hardware Supported: Snagpad PCB, Pro Micro  
+Hardware Availability: [GitHub](https://github.com/flehrad/Snagpad)
 
-Build requires a pro micro.
+Make example for this keyboard (after setting up your build environment):
 
-Can be built as single PCB with custom case, or as two PCB style with standoffs.
+    make snagpad:default
 
-If you like this simple PCB and want to make a donation, you can at https://paypal.me/theboardpodcast
+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).
 
-Check out our:
-
-YouTube (https://www.youtube.com/channel/UCg98oJZNffR9nDLJNkorjqw)
+If you like this simple PCB and want to make a donation, you can do so at https://paypal.me/theboardpodcast.
 
-Podcast (www.libsyn.com/theboardpodcast)
+Check out our:
 
-Patreon (www.patreon.com/theboardpodcast)
+- [YouTube](https://www.youtube.com/channel/UCg98oJZNffR9nDLJNkorjqw)
+- [Podcast](https://podcasts.apple.com/au/podcast/theboard-mechanical-keyboard/id1147089749?mt=2)
+- [Patreon](https://www.patreon.com/theboardpodcast)