summaryrefslogtreecommitdiff
path: root/keyboards/ekow/akira/readme.md
diff options
context:
space:
mode:
authorEugene-Yuan Kou <r02323025@ntu.edu.tw>2022-05-11 00:00:30 +0800
committerGitHub <noreply@github.com>2022-05-10 17:00:30 +0100
commita3e057e779ae1d9f827a859722428f03c2b118f1 (patch)
tree8897f955f708fc24d1892d8fde3cadf1a44c51c0 /keyboards/ekow/akira/readme.md
parent796ededd5950e0378a9466288fbbdc219251f968 (diff)
Adding akira (#16982)
* keyboard:akira initial commit * Update keyboards/ekow/akira/akira.h Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/ekow/akira/keymaps/via/rules.mk Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/ekow/akira/readme.md Co-authored-by: Joel Challis <git@zvecr.com> * Update .gitignore Co-authored-by: Joel Challis <git@zvecr.com> * Update readme.md * Update keyboards/ekow/akira/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Update rules.mk remove redundant content. * added keyboard/ekow/keymaps/via/keymap.c * remove .ccls-cache * add instructions of enter the bootloader * add instructions of enter the bootloader * modify ekow/akira:via * Update keyboards/ekow/akira/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/ekow/akira/keymaps/via/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/ekow/akira/readme.md')
-rw-r--r--keyboards/ekow/akira/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/ekow/akira/readme.md b/keyboards/ekow/akira/readme.md
new file mode 100644
index 0000000000..e1a0c90366
--- /dev/null
+++ b/keyboards/ekow/akira/readme.md
@@ -0,0 +1,24 @@
+# AKIRA
+
+* Keyboard Maintainer: [eugenepy](https://github.com/eugenepy)
+* Hardware Supported: AKIRA pcb, both Hotswap and solderable.
+* Hardware Availability: Not yet on groupbuy
+
+# Build
+Make example for this keyboard (after setting up your build environment):
+
+ make ekow/akira:default
+
+Flashing example for this keyboard:
+
+ make ekow/akira: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 Buttom on the back of the PCB, the board will enter the dfu-mode, no extra pads need to short.
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+