summaryrefslogtreecommitdiffstats
path: root/keyboards/amj40/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2021-02-14 23:21:45 -0800
committerGitHub <noreply@github.com>2021-02-14 23:21:45 -0800
commitfa740f81298dc0965970a4dc7b0b67285bd1985c (patch)
tree7617e178431b7325c974c000a6e70667ba6bdfcd /keyboards/amj40/readme.md
parente768fb83bdf1bc292cefc9f3f70cb1597c3108fc (diff)
AMJ40 Refactor (#11854)
* update keyboard source files - add license headers (attributed to original keyboard submitter) - #pragma once include guards - file template matching - readme update and template matching * set sensible default keyboard settings - enable Bootmagic Lite and Mouse Keys - disable Console and Command - remove default keymap's rules.mk file * remove unnecessary files from default keymap * refactor default keymap * add additional layouts/keymaps * update keyboard readme - add images and bootloader instructions - reformat link list * convert tabs to spaces in default keymap
Diffstat (limited to 'keyboards/amj40/readme.md')
-rwxr-xr-xkeyboards/amj40/readme.md21
1 files changed, 15 insertions, 6 deletions
diff --git a/keyboards/amj40/readme.md b/keyboards/amj40/readme.md
index fbf1d9f229..1d7316fcf5 100755
--- a/keyboards/amj40/readme.md
+++ b/keyboards/amj40/readme.md
@@ -1,14 +1,23 @@
-AMJ40
-===
+# AMJ40
+
+![AMJ40](https://raw.githubusercontent.com/noroadsleft/qmk_images/master/keyboards/amj40/AMJ40-Keyboard-Side-scaled_640.jpg)\
+[PCB photo](https://raw.githubusercontent.com/noroadsleft/qmk_images/master/keyboards/amj40/DSC_1718-768x512_640)
DIY/Assembled compact 40% keyboard.
-Keyboard Maintainer: QMK Community
-Hardware Supported: AMJ40 PCB
-Hardware Availability: https://geekhack.org/index.php?topic=87961.0
+* Keyboard Maintainer: QMK Community
+* Hardware Supported: AMJ40 PCB
+* Hardware Availability: no longer available
+* References: [Flashquark](https://flashquark.com/product/amj40-40-mechanical-keyboard-kit/), [geekhack](https://geekhack.org/index.php?topic=87961.0)
Make example for this keyboard (after setting up your build environment):
make amj40: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 amj40:default:flash
+
+To reset the board into bootloader mode, hold the key at the top left of the keyboard while connecting the USB cable (also erases persistent settings).
+
+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).