drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Update the clueboard readmes (#1459)

Browse source
This commit is contained in:
skullydazed 2017-07-05 00:15:09 -07:00 • committed by GitHub
parent b3d2f05032
commit 60eb2e140d
3 changed files with 33 additions and 117 deletions
Download patch file Download diff file Expand all files Collapse all files

31
keyboards/cluecard/readme.md
View file

@ -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.