summaryrefslogtreecommitdiff
path: root/keyboards/adpenrose/shisaku/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-08-07 21:11:17 +0000
committerQMK Bot <hello@qmk.fm>2022-08-07 21:11:17 +0000
commit972f9a612c0293b16ff5189e694aacd1d2a51916 (patch)
tree51464c6755f4b42fd032474656071d5d8c904b62 /keyboards/adpenrose/shisaku/readme.md
parentb214768e092f6c44cb8f34dc9e7756f48d9c0b2e (diff)
parentd27a6bd629f8ad5a204236c58ed3a8641e75da53 (diff)
downloadqmk_firmware-972f9a612c0293b16ff5189e694aacd1d2a51916.tar.gz
qmk_firmware-972f9a612c0293b16ff5189e694aacd1d2a51916.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/adpenrose/shisaku/readme.md')
-rw-r--r--keyboards/adpenrose/shisaku/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/adpenrose/shisaku/readme.md b/keyboards/adpenrose/shisaku/readme.md
new file mode 100644
index 0000000000..6a3ffeffda
--- /dev/null
+++ b/keyboards/adpenrose/shisaku/readme.md
@@ -0,0 +1,29 @@
+# Shisaku
+
+![shisaku](https://i.imgur.com/42H1h1dh.jpg)
+
+A 40% alice-like keyboard assembled only with THT components, including the option for a solenoid.
+
+## General info
+
+* Keyboard Maintainer: [Arturo Avila](https://github.com/ADPenrose)
+* Hardware Supported: Shisaku v1 PCB
+* Hardware Availability: [Arturo Avila](https://github.com/ADPenrose)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make adpenrose/shisaku:default
+
+Flashing example for this keyboard:
+
+ make adpenrose/shisaku:default:flash
+
+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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Hold down the button labeled "BOOT" and briefly press the button labeled "RESET" on the back of the PCB. To exit the bootloader mode, briefly press the button labeled "RESET" once more.
+* **Keycode in layout**: Press the key mapped to "QK BOOT" if it is available