diff options
author | barrar <jeremiah.barrar@gmail.com> | 2017-05-13 08:37:25 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-05-13 08:37:25 -0700 |
commit | 4fe58aa6ec53b0f2a08b8a80f3465f8544ea5118 (patch) | |
tree | bbccabde9c5ea1493804ec679fe28227885db7d2 /keyboards/tiger_lily/readme.md | |
parent | 9a8904a9c071730ef6712f8be93c38ac4b43fbdb (diff) | |
parent | 04069c94ccc2878fd8b66153f6fc58987461caf2 (diff) |
Merge pull request #1 from qmk/master
pull
Diffstat (limited to 'keyboards/tiger_lily/readme.md')
-rw-r--r-- | keyboards/tiger_lily/readme.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/keyboards/tiger_lily/readme.md b/keyboards/tiger_lily/readme.md new file mode 100644 index 0000000000..b5f30f2e11 --- /dev/null +++ b/keyboards/tiger_lily/readme.md @@ -0,0 +1,32 @@ +tiger_lily keyboard firmware +====================== + +This is the firmware for Rev. 20161114 of the Tiger Lily controller by [Bathroom Epiphanies](http://bathroomepiphanies.com/controllers/), a replacement controller for the [Filco Majestouch 2 104 key](https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=1819). Bathroom Epiphanies has advised that the source is also compatible with the Black Petal controller, however I do not own an example to test against. + +The code was adapted from the [BathroomEpiphanies TMK Firmware](https://github.com/BathroomEpiphanies/epiphanies_tmk_keyboard/tree/master/be_controllers). + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent readme](/). + +## Building + +Download or clone the whole firmware and navigate to the keyboards/tiger_lily 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. + +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 **__\<name\>.c__** and are stored in the `keymaps` folder. |