History

James Young a03aa301de Remove Full Bootmagic (#13846 ) * disambiguate Bootmagic rules in keymaps The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic. This commit edits the files to specify that full Bootmagic is intended. * remove BOOTMAGIC_ENABLE=full setting * unify commented BOOTMAGIC_ENABLE rules in keyboards Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;#[ \t]\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).;\1 = no # Virtual DIP switch configuration;g' {} + ``` * remove commented Bootmagic rules from keymap/user level Command: ``` find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\)./d' {} + ``` * update keyboard BOOTMAGIC_ENABLE rule formatting Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later). Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + ``` update keyboards' BOOTMAGIC_ENABLE settings Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' + ``` * update keymap/user BOOTMAGIC_ENABLE settings Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + ``` * remove and replace inline comments in keyboards and keymap/user files Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1 # Enable Bootmagic Lite;g' '{}' + ``` * rename improperly named makefiles Some files intended to be used as makefiles had improper names causing them to not be used as intended when building. This commit corrects the filenames of the affected files. * update renamed file with new rule formatting * update QMK's template files Updates QMK's `rules.mk` templates to use the new inline comment. * update QMK Docs - remove documentation of full Bootmagic - update links to Bootmagic Lite doc - add doc for Magic Keycodes * rules.mk patch for coarse/ixora and coarse/vinta		2021-08-06 23:59:56 -07:00
..
keymaps/default	Remove/migrate action_get_macro()s from default keymaps (#5625 )	2019-07-15 23:04:02 -07:00
config.h	Remove `MIDI_ENABLE_STRICT` from keyboards' config.h (#11679 )	2021-01-27 17:26:26 +11:00
info.json
nakey.c
nakey.h
readme.md	Modified URLs to point to new locations	2019-01-13 09:11:18 -08:00
rules.mk	Remove Full Bootmagic (#13846 )	2021-08-06 23:59:56 -07:00

readme.md

naKey

Firmware for custom keyboard

Keyboard Maintainer: James Underwood
Hardware Supported: naKey
Hardware Availability: ckeys.org

To build this keyboard, follow the build guide.

Make example for this keyboard (after setting up your build environment):

make ckeys/nakey:default

See build environment setup then the make instructions for more information.

Quantum MK Firmware

For the full Quantum feature list, see the parent readme.

Building

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.

(Note: replace naKey with the name of your keyboard.)

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 make ckeys/nakey:default.

Other Keymaps

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:

qmk_firmware/
- keyboard/
  - keymaps/
    - config.h (optional)
    - keymap.c
    - readme.md
    - rules.mk (optional)

To build the firmware binary hex file with a keymap just do make with a keymap like this:

$ make naKey-[default|jack|<name>]