From c5264d6d89899f19bdeeaf9e2daeb90531617a48 Mon Sep 17 00:00:00 2001
From: MechMerlin <30334081+mechmerlin@users.noreply.github.com>
Date: Wed, 9 May 2018 21:37:04 -0700
Subject: Move ckeys workshop to its own directory (#2928)

* move obelus and nakey to ckeys directory

* delete the originals

* short readme about ckeys

* edit readmes to reflect new changes

* add build guide info..and here's me trying to retrigger the build job
---
 keyboards/ckeys/nakey/readme.md | 49 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 keyboards/ckeys/nakey/readme.md

(limited to 'keyboards/ckeys/nakey/readme.md')

diff --git a/keyboards/ckeys/nakey/readme.md b/keyboards/ckeys/nakey/readme.md
new file mode 100644
index 0000000000..c7250cf506
--- /dev/null
+++ b/keyboards/ckeys/nakey/readme.md
@@ -0,0 +1,49 @@
+# naKey
+
+Firmware for custom keyboard
+
+Keyboard Maintainer: [James Underwood](https://github.com/ju0)  
+Hardware Supported: naKey  
+Hardware Availability: [ckeys.org](https://ckeys.org)
+
+To build this keyboard, follow the [build guide](https://ckeys.org/tutorials/nakey-numpad-build-guide/). 
+
+Make example for this keyboard (after setting up your build environment):
+
+    make ckeys/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 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>]
+```
-- 
cgit v1.2.3