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: [PATCH] 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/config.h | 0 keyboards/{ => ckeys}/nakey/info.json | 0 keyboards/{ => ckeys}/nakey/keymaps/default/keymap.c | 0 keyboards/{ => ckeys}/nakey/keymaps/default/readme.md | 0 keyboards/{ => ckeys}/nakey/nakey.c | 0 keyboards/{ => ckeys}/nakey/nakey.h | 0 keyboards/{ => ckeys}/nakey/readme.md | 8 +++++--- keyboards/{ => ckeys}/nakey/rules.mk | 0 keyboards/{ => ckeys}/obelus/config.h | 0 keyboards/{ => ckeys}/obelus/keymaps/default/config.h | 0 keyboards/{ => ckeys}/obelus/keymaps/default/keymap.c | 0 keyboards/{ => ckeys}/obelus/keymaps/default/readme.md | 0 keyboards/{ => ckeys}/obelus/obelus.c | 0 keyboards/{ => ckeys}/obelus/obelus.h | 0 keyboards/{ => ckeys}/obelus/readme.md | 6 +++--- keyboards/{ => ckeys}/obelus/rules.mk | 0 keyboards/ckeys/readme.md | 9 +++++++++ 17 files changed, 17 insertions(+), 6 deletions(-) rename keyboards/{ => ckeys}/nakey/config.h (100%) rename keyboards/{ => ckeys}/nakey/info.json (100%) rename keyboards/{ => ckeys}/nakey/keymaps/default/keymap.c (100%) rename keyboards/{ => ckeys}/nakey/keymaps/default/readme.md (100%) rename keyboards/{ => ckeys}/nakey/nakey.c (100%) rename keyboards/{ => ckeys}/nakey/nakey.h (100%) rename keyboards/{ => ckeys}/nakey/readme.md (78%) rename keyboards/{ => ckeys}/nakey/rules.mk (100%) rename keyboards/{ => ckeys}/obelus/config.h (100%) rename keyboards/{ => ckeys}/obelus/keymaps/default/config.h (100%) rename keyboards/{ => ckeys}/obelus/keymaps/default/keymap.c (100%) rename keyboards/{ => ckeys}/obelus/keymaps/default/readme.md (100%) rename keyboards/{ => ckeys}/obelus/obelus.c (100%) rename keyboards/{ => ckeys}/obelus/obelus.h (100%) rename keyboards/{ => ckeys}/obelus/readme.md (78%) rename keyboards/{ => ckeys}/obelus/rules.mk (100%) create mode 100644 keyboards/ckeys/readme.md diff --git a/keyboards/nakey/config.h b/keyboards/ckeys/nakey/config.h similarity index 100% rename from keyboards/nakey/config.h rename to keyboards/ckeys/nakey/config.h diff --git a/keyboards/nakey/info.json b/keyboards/ckeys/nakey/info.json similarity index 100% rename from keyboards/nakey/info.json rename to keyboards/ckeys/nakey/info.json diff --git a/keyboards/nakey/keymaps/default/keymap.c b/keyboards/ckeys/nakey/keymaps/default/keymap.c similarity index 100% rename from keyboards/nakey/keymaps/default/keymap.c rename to keyboards/ckeys/nakey/keymaps/default/keymap.c diff --git a/keyboards/nakey/keymaps/default/readme.md b/keyboards/ckeys/nakey/keymaps/default/readme.md similarity index 100% rename from keyboards/nakey/keymaps/default/readme.md rename to keyboards/ckeys/nakey/keymaps/default/readme.md diff --git a/keyboards/nakey/nakey.c b/keyboards/ckeys/nakey/nakey.c similarity index 100% rename from keyboards/nakey/nakey.c rename to keyboards/ckeys/nakey/nakey.c diff --git a/keyboards/nakey/nakey.h b/keyboards/ckeys/nakey/nakey.h similarity index 100% rename from keyboards/nakey/nakey.h rename to keyboards/ckeys/nakey/nakey.h diff --git a/keyboards/nakey/readme.md b/keyboards/ckeys/nakey/readme.md similarity index 78% rename from keyboards/nakey/readme.md rename to keyboards/ckeys/nakey/readme.md index 62688c1aeb..c7250cf506 100644 --- a/keyboards/nakey/readme.md +++ b/keyboards/ckeys/nakey/readme.md @@ -6,9 +6,11 @@ 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 nakey:default + 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. @@ -18,7 +20,7 @@ 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. +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.) @@ -26,7 +28,7 @@ Depending on which keymap you would like to use, you will have to compile slight ### Default -To build with the default keymap, simply run `make naKey-default`. +To build with the default keymap, simply run `make ckeys/nakey:default`. ### Other Keymaps diff --git a/keyboards/nakey/rules.mk b/keyboards/ckeys/nakey/rules.mk similarity index 100% rename from keyboards/nakey/rules.mk rename to keyboards/ckeys/nakey/rules.mk diff --git a/keyboards/obelus/config.h b/keyboards/ckeys/obelus/config.h similarity index 100% rename from keyboards/obelus/config.h rename to keyboards/ckeys/obelus/config.h diff --git a/keyboards/obelus/keymaps/default/config.h b/keyboards/ckeys/obelus/keymaps/default/config.h similarity index 100% rename from keyboards/obelus/keymaps/default/config.h rename to keyboards/ckeys/obelus/keymaps/default/config.h diff --git a/keyboards/obelus/keymaps/default/keymap.c b/keyboards/ckeys/obelus/keymaps/default/keymap.c similarity index 100% rename from keyboards/obelus/keymaps/default/keymap.c rename to keyboards/ckeys/obelus/keymaps/default/keymap.c diff --git a/keyboards/obelus/keymaps/default/readme.md b/keyboards/ckeys/obelus/keymaps/default/readme.md similarity index 100% rename from keyboards/obelus/keymaps/default/readme.md rename to keyboards/ckeys/obelus/keymaps/default/readme.md diff --git a/keyboards/obelus/obelus.c b/keyboards/ckeys/obelus/obelus.c similarity index 100% rename from keyboards/obelus/obelus.c rename to keyboards/ckeys/obelus/obelus.c diff --git a/keyboards/obelus/obelus.h b/keyboards/ckeys/obelus/obelus.h similarity index 100% rename from keyboards/obelus/obelus.h rename to keyboards/ckeys/obelus/obelus.h diff --git a/keyboards/obelus/readme.md b/keyboards/ckeys/obelus/readme.md similarity index 78% rename from keyboards/obelus/readme.md rename to keyboards/ckeys/obelus/readme.md index a9d67b00e8..6767956bf9 100644 --- a/keyboards/obelus/readme.md +++ b/keyboards/ckeys/obelus/readme.md @@ -5,15 +5,15 @@ Obelus Keyboard Maintaintainers: [Ethan Madden](https://github.com/jetpacktuxedo), [James Underwood](https://github.com/ju0) Hardware Supported: Obelus -Hardware Availability: C-Keys soldering workshops, /u/MonkeyPlusPlus +Hardware Availability: [C-Keys soldering workshops](https://ckeys.org/workshops/), [/u/MonkeyPlusPlus](https://www.reddit.com/user/monkeyplusplus) Make example for this keyboard (after setting up your build environment): - make obelus:default + make ckeys/obelus:default Or to make and flash: - make obelus:default:dfu + make ckeys/obelus:default:dfu See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) and [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. diff --git a/keyboards/obelus/rules.mk b/keyboards/ckeys/obelus/rules.mk similarity index 100% rename from keyboards/obelus/rules.mk rename to keyboards/ckeys/obelus/rules.mk diff --git a/keyboards/ckeys/readme.md b/keyboards/ckeys/readme.md new file mode 100644 index 0000000000..01991d9e3f --- /dev/null +++ b/keyboards/ckeys/readme.md @@ -0,0 +1,9 @@ +# Ckeys.org + +[ckeys](https://ckeys.org/) is a mechanical keyboard based non profit, located in Seattle, Washington. + +In addition, to hosting the [Seattle Mechanical Keyboard Meetups](https://ckeys.org/events/), they have [soldering workshops](https://ckeys.org/workshops/) featuring hardware hosted in this repository. + +* Supported Hardware + * The Obelus - 4x4 Macropad + * naKey - Through hole numpad \ No newline at end of file