From: skullydazed Date: Wed, 5 Jul 2017 07:15:09 +0000 (-0700) Subject: Update the clueboard readmes (#1459) X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=60eb2e140d611d08ff6afb766d2f9af7bfb1b1d6;p=qmk_firmware.git Update the clueboard readmes (#1459) --- diff --git a/keyboards/clueboard/readme.md b/keyboards/clueboard/readme.md index 4a76e2908..95b69befc 100644 --- a/keyboards/clueboard/readme.md +++ b/keyboards/clueboard/readme.md @@ -1,97 +1,17 @@ -Clueboard keyboard firmware -====================== +# Clueboard 66% -DIY/Assembled compact 66% keyboard by [Clueboard](http://clueboard.co). +![Clueboard](https://static1.squarespace.com/static/55c13bdee4b099be5dcb82eb/t/5867eeaad2b857fd0d196f4b/1494021396651/IMGP4201.jpg?format=1500w) -For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md). +A fully customizable 66% keyboard. -## First Time Setup +* Keyboard Maintainer: [Zach White](https://github.com/skullydazed) +* Hardware Supported: Clueboard 66% PCB + * rev1 (1.0) + * rev2 (2.0, 2.0.1, 2.1, 2.5, 2.5.1, 2.6) +* Hardware Availability: [clueboard.co](https://clueboard.co/) -Download or clone the whole firmware and navigate to the keyboards/clueboard directory. Once your dev env is setup, you'll be able to generate the default .hex: +Make example for this keyboard (after setting up your build environment): -``` -$ make -``` + make cluepad-default -You will see a lot of output and if everything worked correctly you will see something similar to this: - -``` -Size after: - text data bss dec hex filename - 0 19992 0 19992 4e18 clueboard_rev2_default.hex -``` - -At this point you can press RESET on your Clueboard and flash your keyboard with this command: - -``` -$ make dfu -``` - -If you would like to use one of the alternative keymaps, or create your own, see below. - -## Clueboard 1.0 - -If you have a first generation Clueboard (one with a black PCB) you will need to use the revision 1 code. To do so add `rev1` to your make command, like this: - -``` -$ make rev1 -``` - -And when flashing your keyboard: - -``` -$ make rev1-dfu -``` - -If you are flashing an alternative layout to your rev1, include both `rev1` and `` in your command, for example when flashing max: - -``` -$ make rev1-max-dfu -``` - -## Alternate Keymaps - -There are many alternative and user-contributed layouts available in the [keymaps/](keymaps/) directory. To compile and flash an alternative you will want to add `` to your command: - -``` -$ make skully -``` - -And when flashing your keyboard, put `` between "make" and "dfu": - -``` -$ make skully-dfu -``` - -### Notable Layouts - -These layouts are notable for one reason or another. If you are looking for ideas or inspiration you should look at these first: - -* [keymaps/default](keymaps/default) - The default Clueboard layout -* [keymaps/max](keymaps/max) - A maximised layout that makes use of every key and feature of the Clueboard 2.0 PCB. -* [keymaps/skully](keymaps/skully) - The layout that @skullydazed uses on his own Clueboards. - -## Create Your Own Keymap - -There are a lot of possibilities when creating your own keymap, and the primary documentation for doing that is [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md. As a way to get started, here is the procedure I recommend: - -* Copy `[keymaps/default](keymaps/default/)` to `keymaps/`. -* Compile the firmware (`$ make `) -* Flash the firmware (`$ make -dfu`) -* Make sure everything works like the default keyboard -* Modify `keymaps//readme.md` to tell others about your layout. -* Modify `keymaps//keymap.c` to reflect your desired layout. -* Compile your new custom firmware (`$ make `) -** If you have warnings you may flash without fixing them, but something may not work right. -** If you have any errors you must fix them before continuing. -* Flash the firmware (`$ make -dfu`) - -## Share Your Keymap - -Got your layout dialed in? Please share it with the world so we can benefit from your work! Simply submit a pull request with your layout and we'll include it in the official repository. Please use the following guidelines when putting together your pull request: - -* Include a readme.md that states what your primary keyboard use is, how your layout differs from the default, and highlights anything you think makes your layout particularly great. -* If your layout requires certain features (EG, RGB underlight or backlighting) ensure you have a Makefile and config.h that reflects that -* If your layout requires special hardware to be added, please describe that in the readme.md - -TODO: Write up or link quick how-to on creating and submitting a PR. (Pull requests accepted. :) +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. 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|] -``` - -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. diff --git a/keyboards/cluepad/readme.md b/keyboards/cluepad/readme.md index 8450340f2..f79d6b559 100644 --- a/keyboards/cluepad/readme.md +++ b/keyboards/cluepad/readme.md @@ -1,4 +1,15 @@ -Cluepad number pad firmware -====================== +# Cluepad -TODO: to be updated. +![Cluepad](https://static1.squarespace.com/static/55c13bdee4b099be5dcb82eb/5842fbdce3df28eae5ec557e/5844fb2cb8a79bbdfd63bad1/1498501250178/IMGP3931.jpg?format=750w) + +A basic 17 key numpad PCB. + +* Keyboard Maintainer: [Zach White](https://github.com/skullydazed) +* Hardware Supported: Cluepad PCB 1.0 +* Hardware Availability: [clueboard.co](https://clueboard.co/) + +Make example for this keyboard (after setting up your build environment): + + make cluepad-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.