diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-10-14 11:32:19 -1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-14 11:32:19 -1000 |
| commit | 800ec55dfca06b4630acf62cbb5f130c4031e4f1 (patch) | |
| tree | 718e43d976bc71627558b5f9e1b657e8a64e4131 /keyboards/amj40 | |
| parent | e5dc2253e26a105a11e0fad3e4e39c306e49cc92 (diff) | |
| download | qmk_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')
| -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. | ||