logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

readme.md (1803B)

    

  1. # naKey
  3. Firmware for custom keyboard
  5. Keyboard Maintainer: [James Underwood](https://github.com/ju0)  
  6. Hardware Supported: naKey  
  7. Hardware Availability: [ckeys.org](https://ckeys.org)
  9. To build this keyboard, follow the [build guide](https://ckeys.org/tutorials/nakey-numpad-build-guide/). 
  11. Make example for this keyboard (after setting up your build environment):
  13.     make ckeys/nakey:default
  15. See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
  17. ## Quantum MK Firmware
  19. For the full Quantum feature list, see [the parent readme](/).
  21. ## Building
  23. Download or clone the whole firmware and navigate to the root folder. Once your dev env is setup, you'll be able to type `make ckeys/nakey:default` to generate your .hex - you can then use the Teensy Loader to program your .hex file. 
  25. (Note: replace naKey with the name of your keyboard.)
  27. Depending on which keymap you would like to use, you will have to compile slightly differently.
  29. ### Default
  31. To build with the default keymap, simply run `make ckeys/nakey:default`.
  33. ### Other Keymaps
  35. Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder. Create a `readme.md` and a `keymap.c` file to complete your new keymap. When you are done your file tree should look like this:
  37. * `qmk_firmware/`
  38.   * `keyboard/`
  39.     * `keymaps/`
  40.       * `config.h` (optional)
  41.       * `keymap.c`
  42.       * `readme.md`
  43.       * `rules.mk` (optional)
  45. To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
  47. ```
  48. $ make naKey-[default|jack|<name>]
  49. ```