summaryrefslogtreecommitdiff
path: root/keyboards/matrix/falcon/readme.md
diff options
context:
space:
mode:
authoryulei <yuleiz@gmail.com>2021-08-14 14:35:32 +0800
committerGitHub <noreply@github.com>2021-08-14 16:35:32 +1000
commited350a1aa6eac4194a0f75af798b47a6e6e85164 (patch)
treef09b08c32549cafc12c8ac20a197b7ecf90f8380 /keyboards/matrix/falcon/readme.md
parent088d6abf5455ab8ea3e7f3071cd7ce674f12fce8 (diff)
add falcon keyboard (#13674)
* added falcon keyboard * Update keyboards/matrix/falcon/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/matrix/falcon/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Apply suggestions from code review Co-authored-by: Drashna Jaelre <drashna@live.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * added description for the bootloader * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/matrix/falcon/readme.md')
-rw-r--r--keyboards/matrix/falcon/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/matrix/falcon/readme.md b/keyboards/matrix/falcon/readme.md
new file mode 100644
index 0000000000..c283650fcf
--- /dev/null
+++ b/keyboards/matrix/falcon/readme.md
@@ -0,0 +1,25 @@
+# Falcon AVR
+
+PCB using atmega32u4 for the Matrix Falcon
+
+* Keyboard Maintainer: [astro](https://github.com/yulei)
+* Hardware Supported: Matrix Falcon
+* Hardware Availability: Limited GB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make matrix/falcon:default
+
+Flashing example for this keyboard:
+
+ make matrix/falcon: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 short cut the *RST* pin with the *GND* pin (pin at the topside of the *RST*) on the back of the PCB.
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available. \ No newline at end of file