qmk_firmware/keyboards/crin/readme.md
James Young 424b9ff709
Crin Refactor (#13982)
* rename LAYOUT_default to LAYOUT_all

* apply human-friendly formatting to info.json

* correct keyboard dimensions

* correct data for LAYOUT_tsangan

* add labels to LAYOUT_ansi data

* add labels to LAYOUT_all data

* add labels to LAYOUT_iso data

* crin.h: update grid alignment of matrix identifiers

* crin.h: add matrix diagram

* physically position matrix identifiers for LAYOUT_all

- move k2d to top row (right half of split Backspace)
- move k41 to fourth row (right half of split Left Shift [KC_NUBS])

* physically position matrix identifiers for LAYOUT_iso

- move k1d to top row ([KC_NUHS])
- add k41 to fourth row ([KC_NUBS], previously missing)

* refactor keymaps

- grid-align keycodes
- use four-space indent

* correct data for LAYOUT_iso

- move Enter key to home row

* rename LAYOUT_tsangan to LAYOUT_ansi_tsangan

* add LAYOUT_iso_tsangan

* update readme.md

- add `make` command for building
- add "Flashing example..."
- touch-up bootloader jump instructions (previous Markdown didn't render ideally on GitHub)

* extend keymap functionality

- add Grave Accent, Function keys, Print Screen, Scroll Lock and Pause keycodes to keymaps
- add RESET keycode (Fn+R)
- use KC_RGHT for Right arrow

* touch-up bootloader instructions on readme

- note that Bootmagic Lite jump erases persistent settings
- note that Fn+R is RESET keycode by default
2021-08-13 17:01:05 -07:00

25 lines
1.0 KiB
Markdown

# Bachoo Crin
Crin is an F-rowless 65%.
* Keyboard Maintainer: [KnoblesseOblige](https://github.com/KnoblesseOblige)
* Hardware Supported: STM32F303CBT
* Hardware Availability: TBD
Make example for this keyboard (after setting up your build environment):
make crin:default
Flashing example for this keyboard:
make crin:default:flash
To reset the board into bootloader mode, do one of the following:
* Hold Esc while plugging the PCB in, if Bootmagic Lite is enabled (also erases persistent settings).
* Press the RESET keycode, if programmed on the keymap (Fn+R by default).
* Slide the switch just below the reset button to the left and press the reset button.
* Please note that you must slide it back to the right for the PCB to boot QMK again.
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).