summaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/twig/twig50/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-10-05 01:40:52 +0000
committerQMK Bot <hello@qmk.fm>2022-10-05 01:40:52 +0000
commitdd7673f3a771d5866843c82d42b30c7bbc58b9ba (patch)
treed74870b79ed5903e637ea0078fba2c30c2c02125 /keyboards/handwired/twig/twig50/readme.md
parent0d5e0e3b2af3bfe53a8a1e111ce35731abb695d3 (diff)
parent3f63bbc7d829d7269e9caa89f128adf86ae5b196 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/handwired/twig/twig50/readme.md')
-rw-r--r--keyboards/handwired/twig/twig50/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/handwired/twig/twig50/readme.md b/keyboards/handwired/twig/twig50/readme.md
new file mode 100644
index 0000000000..ae3692c1a0
--- /dev/null
+++ b/keyboards/handwired/twig/twig50/readme.md
@@ -0,0 +1,29 @@
+# Twig50
+
+![Twig50](https://user-images.githubusercontent.com/12627081/185365257-03a4904b-8432-445b-9eca-67f2aff57cd9.jpg "Sample build")
+
+Handwired 50 key with Proton C.
+
+* Keyboard Maintainer: [Takeshi Noda](https://github.com/nodatk)
+* Hardware Supported: Proton C
+* Hardware Availability: Sorry, not available for now
+
+Layout data is available [here](http://www.keyboard-layout-editor.com/#/gists/8df4caf51c8d57e4069e2ae19965f02c).
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/twig/twig50:default
+
+Flashing example for this keyboard:
+
+ make handwired/twig/twig50: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**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available