summaryrefslogtreecommitdiffstats
path: root/keyboards/viktus/osav2_numpad_topre/readme.md
diff options
context:
space:
mode:
authorblindassassin111 <38090555+blindassassin111@users.noreply.github.com>2023-06-14 23:20:49 -0500
committerGitHub <noreply@github.com>2023-06-14 22:20:49 -0600
commit3703d5a83b6ba6d1abd20049eb920fbce417f91c (patch)
tree6b88cc642c3562319ee4269e18be3dd9de449583 /keyboards/viktus/osav2_numpad_topre/readme.md
parenta2c17d5518b9301abe8f40b4ca9e62a6e9e38d64 (diff)
[Keyboard] Adding OSAv2 Numpad Topre support (#21224)
Diffstat (limited to 'keyboards/viktus/osav2_numpad_topre/readme.md')
-rw-r--r--keyboards/viktus/osav2_numpad_topre/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/viktus/osav2_numpad_topre/readme.md b/keyboards/viktus/osav2_numpad_topre/readme.md
new file mode 100644
index 0000000000..990bfe04fe
--- /dev/null
+++ b/keyboards/viktus/osav2_numpad_topre/readme.md
@@ -0,0 +1,27 @@
+# OSAv2 Numpad - Topre
+
+![osav2_numpad_topre](https://i.imgur.com/G6yNtJMh.png)
+
+An OSAv2 Numpad in topre flavor.
+
+- Keyboard Maintainer: BlindAssassin111
+- Hardware Supported: OSAv2 Numpad Topre PCB
+- Hardware Availability: Viktus Design LLC
+
+Make example for this keyboard (after setting up your build environment):
+
+ make viktus/osav2_numpad_topre:default
+
+Flashing example for this keyboard:
+
+ make viktus/osav2_numpad_topre: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 `QK_BOOT` if it is available