aboutsummaryrefslogtreecommitdiff
path: root/keyboards/amj40/readme.md
diff options
context:
space:
mode:
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 e705f20fe..42c5374d5 100755
--- a/keyboards/amj40/readme.md
+++ b/keyboards/amj40/readme.md
@@ -1,35 +1,14 @@
1AMJ40 keyboard firmware 1AMJ40
2====================== 2===
3DIY/Assembled compact 40% keyboard.
4
5Ported by N.Hou from the original TMK firmware.
6
7*Supports both backlight LEDs as well as RGB underglow.
8
9*For reference, the AMJ40 uses pin D3 for underglow lighting.
10
11## Quantum MK Firmware
12
13For the full Quantum feature list, see [the parent readme.md](/readme.md).
14
15## Building
16
17Download or clone the whole firmware and navigate to the keyboards/amj40
18folder. Once your dev env is setup, you'll be able to type `make` to generate
19your .hex - you can then use `make dfu` to program your PCB once you hit the
20reset button.
21
22Depending on which keymap you would like to use, you will have to compile
23slightly differently.
24
25### Default
26To build with the default keymap, simply run `sudo make all`.
27The .hex file will appear in the root of the qmk firmware folder.
28
29 3
4DIY/Assembled compact 40% keyboard.
30 5
6Keyboard Maintainer: QMK Community
7Hardware Supported: AMJ40 PCB
8Hardware Availability: https://geekhack.org/index.php?topic=87961.0
31 9
32### Original tmk firmware 10Make example for this keyboard (after setting up your build environment):
33The original firmware that was used to port to qmk can be found [here](https://github.com/AMJKeyboard/AMJ40).
34 11
12 make amj40:default
35 13
14See [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.