diff options
| author | Cole Markham <github@ccmcomputing.net> | 2017-12-08 22:51:49 -0600 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-12-09 00:05:35 -0500 |
| commit | f74f0ac06bbc2c163e2f8575e0855974bd4c95d1 (patch) | |
| tree | 337fae59b878807cbf55f4048f1345b79e55341d /keyboards/meira | |
| parent | a9a46adba0e005f6fecfb5ed47fe8a5eec4b06f4 (diff) | |
| download | qmk_firmware-f74f0ac06bbc2c163e2f8575e0855974bd4c95d1.tar.gz qmk_firmware-f74f0ac06bbc2c163e2f8575e0855974bd4c95d1.zip | |
Update Meira readme
Diffstat (limited to 'keyboards/meira')
| -rw-r--r-- | keyboards/meira/readme.md | 35 |
1 files changed, 19 insertions, 16 deletions
diff --git a/keyboards/meira/readme.md b/keyboards/meira/readme.md index ef69b1a80..6d5d9b553 100644 --- a/keyboards/meira/readme.md +++ b/keyboards/meira/readme.md | |||
| @@ -1,28 +1,31 @@ | |||
| 1 | meira keyboard firmware | 1 | # Meira |
| 2 | ====================== | ||
| 3 | 2 | ||
| 4 | ## Quantum MK Firmware | 3 |  |
| 5 | 4 | ||
| 6 | For the full Quantum feature list, see [the parent readme](/). | 5 | A 4x12 ortholinear low-profile keyboard. |
| 7 | 6 | ||
| 8 | ## Building | 7 | Keyboard Maintainer: [Cole Markham](https://github.com/colemarkham) |
| 8 | Hardware Supported: Meira/ProMicro, Meira/FeatherBLE | ||
| 9 | Hardware Availability: [WoodKeys.click](https://woodkeys.click/meira) | ||
| 9 | 10 | ||
| 10 | Download or clone the whole firmware and navigate to the keyboards/meira 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. | 11 | Two controllers are support: the Pro Micro, and the Adafruit Feather BLE 32u4. Support for each is defined as a hardware revision subfolder in QMK. Main differences include processor frequencies and matrix pinouts. |
| 11 | 12 | ||
| 12 | Depending on which keymap you would like to use, you will have to compile slightly differently. | 13 | Make example for this keyboard (after setting up your build environment): |
| 13 | 14 | ||
| 14 | ### Default | 15 | make meira/promicro:default |
| 15 | 16 | ||
| 16 | To build with the default keymap, simply run `make default`. | 17 | or |
| 17 | 18 | ||
| 18 | ### Other Keymaps | 19 | make meira/featherble:default |
| 19 | 20 | ||
| 20 | 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. | 21 | 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 on generic QMK configuration and setup. |
| 21 | 22 | ||
| 22 | To build the firmware binary hex file with a keymap just do `make` with a keymap like this: | 23 | Both the Pro Micro and the Feather BLE use the Catalina bootloader, which is typically programmed using avrdude. |
| 23 | 24 | ||
| 24 | ``` | 25 | ## Matrix |
| 25 | $ make [default|jack|<name>] | ||
| 26 | ``` | ||
| 27 | 26 | ||
| 28 | Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. | 27 | In order to have enough pins for the matrix and other functions, a custom matrix is implemented using a demultiplexer to scan the columns. Since the demux is active low, the diodes must be oriented with the cathode connected to the demux pin. When looking at the bottom of the board with the controller at the top right, the cathode mark on the diode should be toward the left. |
| 28 | |||
| 29 | ## LED Controller | ||
| 30 | |||
| 31 | The in-switch LEDs are driven by an ISSI LED controller (IS31FL3731). The micro controller communicates with this chip using I2C. Individual LED control is possible, but currently only general backlighting support is implemented. This functionality is located in lighting.c, issi.c, and TWILib.c. \ No newline at end of file | ||