diff options
Diffstat (limited to 'keyboards/amj40/readme.md')
-rwxr-xr-x | keyboards/amj40/readme.md | 39 |
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 @@ | |||
1 | AMJ40 keyboard firmware | 1 | AMJ40 |
2 | ====================== | 2 | === |
3 | DIY/Assembled compact 40% keyboard. | ||
4 | |||
5 | Ported 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 | |||
13 | For the full Quantum feature list, see [the parent readme.md](/readme.md). | ||
14 | |||
15 | ## Building | ||
16 | |||
17 | Download or clone the whole firmware and navigate to the keyboards/amj40 | ||
18 | folder. Once your dev env is setup, you'll be able to type `make` to generate | ||
19 | your .hex - you can then use `make dfu` to program your PCB once you hit the | ||
20 | reset button. | ||
21 | |||
22 | Depending on which keymap you would like to use, you will have to compile | ||
23 | slightly differently. | ||
24 | |||
25 | ### Default | ||
26 | To build with the default keymap, simply run `sudo make all`. | ||
27 | The .hex file will appear in the root of the qmk firmware folder. | ||
28 | |||
29 | 3 | ||
4 | DIY/Assembled compact 40% keyboard. | ||
30 | 5 | ||
6 | Keyboard Maintainer: QMK Community | ||
7 | Hardware Supported: AMJ40 PCB | ||
8 | Hardware Availability: https://geekhack.org/index.php?topic=87961.0 | ||
31 | 9 | ||
32 | ### Original tmk firmware | 10 | Make example for this keyboard (after setting up your build environment): |
33 | The 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 | ||
14 | 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. | ||