aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/amj40/readme.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-08-03 20:57:44 -0400
committerGitHub <noreply@github.com>2017-08-03 20:57:44 -0400
commit5c44d40a0c208d706c8cd298ba90019b18841cb3 (patch)
treecbf8d6cd357e92bf7074fc82a7abfe9c89b67236 /keyboards/amj40/readme.md
parent479139f9d4ef981a2f10918f0fb5a2c148ca0c8b (diff)
parent088dfb7db5b62831570c20f7e438ba0f0a612b74 (diff)
downloadfirmware-5c44d40a0c208d706c8cd298ba90019b18841cb3.tar.gz
firmware-5c44d40a0c208d706c8cd298ba90019b18841cb3.tar.bz2
firmware-5c44d40a0c208d706c8cd298ba90019b18841cb3.zip
Merge pull request #1540 from fabiant7t/master
amj40 added; my layouts for Let's Split, amj40 and XD75
Diffstat (limited to 'keyboards/amj40/readme.md')
-rwxr-xr-xkeyboards/amj40/readme.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/keyboards/amj40/readme.md b/keyboards/amj40/readme.md
new file mode 100755
index 000000000..e705f20fe
--- /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).
+
+