qmk_firmware/keyboards/bemeier/bmek/README.md
Jan Kolkmeier 4b9c3dc2e5
add keyboard: bemeier/bmek (revisited) (#10144)
* bmek keyboard support

* Update keyboards/bemeier/bmek/bmek.h

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Update keyboards/bemeier/bmek/rules.mk

Co-authored-by: Drashna Jaelre <drashna@live.com>

* moved shutdown behavior to shutdown hook

* removed dynamic macro option statement

* Apply suggestions from code review

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* change layout name in via

* move/copy root rules to revs

* Apply suggestions from code review

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Apply suggestions from code review

Co-authored-by: Drashna Jaelre <drashna@live.com>

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-09-08 22:25:13 -07:00

31 lines
1.3 KiB
Markdown
Executable File

# BMEK
![BMEK](https://i.imgur.com/p1KFi6ql.jpg)
BMEK combines the best of HHKB & Alice-likes. All PCB and case design files are open source.
* Keyboard Maintainer: [Bemeier](https://github.com/Bemeier)
* Hardware Supported: BMEK PCB rev1, rev2, rev3
* Hardware Availability: Case & PCB files: [github.com/bemeier/bmek](https://github.com/bemeier/bmek)
Make example for this keyboard, for an hhkb-like layout and keymap (after setting up your build environment):
make bemeier/bmek/rev3:default
Make the VIA compatible firmware:
make bemeier/bmek/rev3:via
The ```rev3```, denotes the version of the PCB.
Check on the PCB to find out which version you have, and set it to rev1, rev2 or rev3 accordingly (the BMEK group buy PCBs are all rev3).
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
# Layouts
Starting with rev3 (the version of the PCB to be shipped in the GB), the following layout options are supported:
![layouts](https://i.imgur.com/XuFxwthl.png)
Note that the keymap shown above may not accurately reflect the default keymap of the firmware (see the keymaps folder).