diff options
author | Balz Guenat <balz.guenat@gmail.com> | 2017-08-07 21:54:06 +0200 |
---|---|---|
committer | Balz Guenat <balz.guenat@gmail.com> | 2017-08-07 21:54:06 +0200 |
commit | d18df8ef7a7e0528a29fdc96d4843ace54605121 (patch) | |
tree | 44f75b9bccd3efa130d622736726a5f1c83531f6 /keyboards/amj40/readme.md | |
parent | 308bec28bb76f4305d0f084252d7cf207f1b3d83 (diff) | |
parent | 933701c2129c0c585ecd8ba37c41b091a7dc687f (diff) |
Merge remote-tracking branch 'upstream/master' into bananasplit
# Conflicts:
# keyboards/bananasplit/Makefile
# keyboards/bananasplit/bananasplit.c
# keyboards/bananasplit/bananasplit.h
# keyboards/bananasplit/config.h
# keyboards/bananasplit/keymaps/default/keymap.c
# keyboards/bananasplit/rules.mk
Diffstat (limited to 'keyboards/amj40/readme.md')
-rwxr-xr-x | keyboards/amj40/readme.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/keyboards/amj40/readme.md b/keyboards/amj40/readme.md new file mode 100755 index 0000000000..e705f20fea --- /dev/null +++ b/keyboards/amj40/readme.md @@ -0,0 +1,35 @@ +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. + + + + +### Original tmk firmware +The original firmware that was used to port to qmk can be found [here](https://github.com/AMJKeyboard/AMJ40). + + |