briemens/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Make the bulk of our keyboards match the readme.md standard

Browse Source
This commit is contained in:
skullY
2017-08-16 15:08:16 -07:00
committed by Jack Humbert
parent 2ee0dc7793
commit 4e73b0b8d7
32 changed files with 355 additions and 1155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
keyboards/tiger_lily/readme.md
View File

@@ -1,32 +1,16 @@
tiger_lily keyboard firmware
======================
tiger_lily
==========
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
Keyboard Maintainer: QMK Community
Hardware Supported: Tiger Lily
Hardware Availability: https://geekhack.org/index.php?topic=46700.0
For the full Quantum feature list, see [the parent readme](/).
Make example for this keyboard (after setting up your build environment):
## Building
make tiger_lily-default
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.
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.