diff options
| author | skullydazed <skullydazed@users.noreply.github.com> | 2017-07-05 00:15:09 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-07-05 00:15:09 -0700 |
| commit | 60eb2e140d611d08ff6afb766d2f9af7bfb1b1d6 (patch) | |
| tree | 771daf7b4af30abc015a7733b1feb90e607436d1 /keyboards/cluecard/readme.md | |
| parent | b3d2f050323bcfda1517b26f4adcb54e7af87c51 (diff) | |
| download | firmware-60eb2e140d611d08ff6afb766d2f9af7bfb1b1d6.tar.gz firmware-60eb2e140d611d08ff6afb766d2f9af7bfb1b1d6.tar.bz2 firmware-60eb2e140d611d08ff6afb766d2f9af7bfb1b1d6.zip | |
Update the clueboard readmes (#1459)
Diffstat (limited to 'keyboards/cluecard/readme.md')
| -rw-r--r-- | keyboards/cluecard/readme.md | 31 |
1 files changed, 8 insertions, 23 deletions
diff --git a/keyboards/cluecard/readme.md b/keyboards/cluecard/readme.md index be13fc017..d9daa0b2b 100644 --- a/keyboards/cluecard/readme.md +++ b/keyboards/cluecard/readme.md @@ -1,28 +1,13 @@ -cluecard keyboard firmware -====================== +# Cluecard -## Quantum MK Firmware +A simple QMK dev kit. -For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). +* Keyboard Maintainer: [Zach White](https://github.com/skullydazed) +* Hardware Supported: Cluecard 1.0 +* Hardware Availability: Special gift from [skullydazed](https://github.com/skullydazed) -## Building +Make example for this keyboard (after setting up your build environment): -Download or clone the whole firmware and navigate to the keyboards/cluecard folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. + make cluecard-default -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 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, and see keymap documentation (you can find in top readme.md) and existant keymap files. - -To build the firmware binary hex file with a keymap just do `make` with a keymap like this: - -``` -$ make [default|jack|<name>] -``` - -Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` +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. |