summaryrefslogtreecommitdiffstats
path: root/keyboards/crin/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2021-08-13 17:01:05 -0700
committerGitHub <noreply@github.com>2021-08-13 17:01:05 -0700
commit424b9ff7090d8407bd6bc56ff42afff05acecb12 (patch)
tree3f6589fc7809f5a0bc9e7d7c08b86f3023dcd000 /keyboards/crin/readme.md
parentaf98005b0252cea38cccd28d7aa72109f3a28f52 (diff)
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
Diffstat (limited to 'keyboards/crin/readme.md')
-rw-r--r--keyboards/crin/readme.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/keyboards/crin/readme.md b/keyboards/crin/readme.md
index 36a2080c42..1912cee1f7 100644
--- a/keyboards/crin/readme.md
+++ b/keyboards/crin/readme.md
@@ -8,13 +8,17 @@ Crin is an F-rowless 65%.
Make example for this keyboard (after setting up your build environment):
+ make crin:default
+
+Flashing example for this keyboard:
+
make crin:default:flash
-To enter the bootloader either:
+To reset the board into bootloader mode, do one of the following:
-0. Hold Esc while plugging the PCB in, if BOOTMAGIC lite is enabled.
-0. Press the RESET keycode, if programmed on the keymap.
-0. Slide the switch just below the reset button to the left and press the reset button.
+* 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).