summaryrefslogtreecommitdiff
path: root/keyboards/nakey/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/nakey/readme.md')
-rw-r--r--keyboards/nakey/readme.md47
1 files changed, 0 insertions, 47 deletions
diff --git a/keyboards/nakey/readme.md b/keyboards/nakey/readme.md
deleted file mode 100644
index 62688c1aeb..0000000000
--- a/keyboards/nakey/readme.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# naKey
-
-Firmware for custom keyboard
-
-Keyboard Maintainer: [James Underwood](https://github.com/ju0)
-Hardware Supported: naKey
-Hardware Availability: [ckeys.org](https://ckeys.org)
-
-Make example for this keyboard (after setting up your build environment):
-
- make nakey:default
-
-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.
-
-## 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 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 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>]
-```