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
This commit is contained in:
parent
5346cb2d20
commit
c5264d6d89
|
@ -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
|
||||
|
|
@ -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.
|
||||
|
|
@ -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
|
Loading…
Reference in New Issue