keyboards/nakey/readme.md

   1 # naKey
   2
   3 Firmware for custom keyboard
   4
   5 Keyboard Maintainer: [James Underwood](https://github.com/ju0)
   6 Hardware Supported: naKey
   7 Hardware Availability: [ckeys.org](https://ckeys.org)
   8
   9 Make example for this keyboard (after setting up your build environment):
  10
  11     make nakey:default
  12
  13 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.
  14
  15 ## Quantum MK Firmware
  16
  17 For the full Quantum feature list, see [the parent readme](/).
  18
  19 ## Building
  20
  21 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 naKey-default` to generate your .hex - you can then use the Teensy Loader to program your .hex file.
  22
  23 (Note: replace naKey with the name of your keyboard.)
  24
  25 Depending on which keymap you would like to use, you will have to compile slightly differently.
  26
  27 ### Default
  28
  29 To build with the default keymap, simply run `make naKey-default`.
  30
  31 ### Other Keymaps
  32
  33 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:
  34
  35 * `qmk_firmware/`
  36   * `keyboard/`
  37     * `keymaps/`
  38       * `config.h` (optional)
  39       * `keymap.c`
  40       * `readme.md`
  41       * `rules.mk` (optional)
  42
  43 To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
  44
  45 ```
  46 $ make naKey-[default|jack|<name>]
  47 ```