keyboards/amj60/readme.md

   1 AMJ60 keyboard firmware
   2 ======================
   3 DIY/Assembled compact 60% keyboard.
   4
   5 ## Quantum MK Firmware
   6
   7 For the full Quantum feature list, see [the parent readme.md](/readme.md).
   8
   9 ## Building
  10
  11 Download or clone the whole firmware and navigate to the keyboards/amj60
  12 folder. Once your dev env is setup, you'll be able to type `make` to generate
  13 your .hex - you can then use `make dfu` to program your PCB once you hit the
  14 reset button.
  15
  16 Depending on which keymap you would like to use, you will have to compile
  17 slightly differently.
  18
  19 ### Default
  20 To build with the default keymap, simply run `make`.
  21
  22 ### Other Keymaps
  23 Several version of keymap are available in advance but you are recommended to
  24 define your favorite layout yourself. To define your own keymap create file
  25 named `<name>.c` in the keymaps folder, and see keymap document (you can find
  26 in top readme.md) and existent keymap files.
  27
  28 To build the firmware binary hex file with a keymap just do `make` with
  29 `KEYMAP` option like:
  30 ``
  31 $ make KEYMAP=[default|jack|<name>]
  32 ``
  33 Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps`
  34 folder.
  35
  36 ## Variations
  37 KEYMAP macros for the following layouts are available:
  38
  39 * default, for all the available, possible keys
  40 * ANSI, for 60% ANSI keyboard
  41 * ISO
  42 * ISO w/ split right shift key
  43 * HHKB
  44
  45 Remark: all but "ISO w/ split right shift key" are untested and were done to the best of my knowledge.
  46
  47 ### Original tmk firmware
  48 The original firmware that was used to port to qmk can be found [here](https://github.com/AMJKeyboard/AMJ60).
  49
  50 ## Further information
  51 Since information and documentation for this board are sparse, (at least for non-chinese speaking ppl) here is everything that could be found
  52
  53 * [geekhack discussion](https://geekhack.org/index.php?topic=53070.0)
  54 * [chinese discussion](https://www.v2ex.com/t/161887)
  55 * Board has [dedicated pinouts](https://i.imgur.com/D0sWhyh.jpg?1) for a bluetooth module
  56 * has pins for external power [picture](https://i.imgur.com/00VrtIp.jpg?1).
  57 * most information comes from [reddit](https://www.reddit.com/r/MechanicalKeyboards/comments/32oonr/gh60_pcb_for_your_custom_keyboard/)