Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move ckeys workshop to its own directory #2928

Merged
merged 5 commits into from
May 10, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 5 additions & 3 deletions keyboards/nakey/readme.md → keyboards/ckeys/nakey/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -18,15 +20,15 @@ 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.)

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`.
To build with the default keymap, simply run `make ckeys/nakey:default`.

### Other Keymaps

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

File renamed without changes.
9 changes: 9 additions & 0 deletions keyboards/ckeys/readme.md
Original file line number Diff line number Diff line change
@@ -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