summaryrefslogtreecommitdiff
path: root/keyboards/tiger_lily/readme.md
diff options
context:
space:
mode:
authorJack Humbert2017-05-11 14:34:02 -0400
committerGitHub2017-05-11 14:34:02 -0400
commitb412bb8d8cc7e1435c170cd20576f354611a7b64 (patch)
tree05c0af1cf76d2c2234ba97387b13e05cacc83e68 /keyboards/tiger_lily/readme.md
parentd6ce42b01c2d4525c56433580411c52af2a6c1b2 (diff)
parent84a358845bbed754b5b0c061ff36773dae131cfd (diff)
Merge pull request #1283 from TerryMathews/master
Establish support for Bathroom Epiphanies Tiger Lily controller
Diffstat (limited to 'keyboards/tiger_lily/readme.md')
-rw-r--r--keyboards/tiger_lily/readme.md32
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 000000000..b5f30f2e1
--- /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.