summaryrefslogtreecommitdiff
path: root/keyboards/amj40/readme.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-10-14 11:32:19 -1000
committerGitHub <noreply@github.com>2017-10-14 11:32:19 -1000
commit800ec55dfca06b4630acf62cbb5f130c4031e4f1 (patch)
tree718e43d976bc71627558b5f9e1b657e8a64e4131 /keyboards/amj40/readme.md
parente5dc2253e26a105a11e0fad3e4e39c306e49cc92 (diff)
downloadqmk_firmware-800ec55dfca06b4630acf62cbb5f130c4031e4f1.tar.gz
qmk_firmware-800ec55dfca06b4630acf62cbb5f130c4031e4f1.zip
Make arguments redo, subproject elimination (#1784)
* redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * start to update readmes and keyboards * look in keyboard directories for board.mk * update visualizer rules * fix up some other keyboards/keymaps * fix arm board ld includes * fix board rules * fix up remaining keyboards * reset layout variable * reset keyboard_layouts * fix remainging keymaps/boards * update readmes, docs * add note to makefile error * update readmes * remove planck keymap warnings * update references and docs * test out tarvis build stages * don't use stages for now * don't use stages for now
Diffstat (limited to 'keyboards/amj40/readme.md')
-rwxr-xr-xkeyboards/amj40/readme.md39
1 files changed, 9 insertions, 30 deletions
diff --git a/keyboards/amj40/readme.md b/keyboards/amj40/readme.md
index e705f20fea..42c5374d52 100755
--- a/keyboards/amj40/readme.md
+++ b/keyboards/amj40/readme.md
@@ -1,35 +1,14 @@
-AMJ40 keyboard firmware
-======================
-DIY/Assembled compact 40% keyboard.
-
-Ported by N.Hou from the original TMK firmware.
-
-*Supports both backlight LEDs as well as RGB underglow.
-
-*For reference, the AMJ40 uses pin D3 for underglow lighting.
-
-## Quantum MK Firmware
-
-For the full Quantum feature list, see [the parent readme.md](/readme.md).
-
-## Building
-
-Download or clone the whole firmware and navigate to the keyboards/amj40
-folder. Once your dev env is setup, you'll be able to type `make` to generate
-your .hex - you can then use `make dfu` to program your PCB once you hit the
-reset button.
-
-Depending on which keymap you would like to use, you will have to compile
-slightly differently.
-
-### Default
-To build with the default keymap, simply run `sudo make all`.
-The .hex file will appear in the root of the qmk firmware folder.
-
+AMJ40
+===
+DIY/Assembled compact 40% keyboard.
+Keyboard Maintainer: QMK Community
+Hardware Supported: AMJ40 PCB
+Hardware Availability: https://geekhack.org/index.php?topic=87961.0
-### Original tmk firmware
-The original firmware that was used to port to qmk can be found [here](https://github.com/AMJKeyboard/AMJ40).
+Make example for this keyboard (after setting up your build environment):
+ make amj40:default
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.