summaryrefslogtreecommitdiff
path: root/keyboards/viktus/osav2_topre/readme.md
diff options
context:
space:
mode:
authorblindassassin111 <38090555+blindassassin111@users.noreply.github.com>2023-06-11 01:27:13 -0500
committerGitHub <noreply@github.com>2023-06-10 23:27:13 -0700
commit8cd9f07c305b704a8fd163bd2dbc1891e80c3b18 (patch)
tree565fd706d00f3c874e17b3f014b5146aea7b8d40 /keyboards/viktus/osav2_topre/readme.md
parentdd8b4dce55bd1845c69d4472bc3ce6338dcfa278 (diff)
[Keyboard] Adding OSAv2 Topre PCB (#21080)
Diffstat (limited to 'keyboards/viktus/osav2_topre/readme.md')
-rw-r--r--keyboards/viktus/osav2_topre/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/viktus/osav2_topre/readme.md b/keyboards/viktus/osav2_topre/readme.md
new file mode 100644
index 0000000000..6379644cd6
--- /dev/null
+++ b/keyboards/viktus/osav2_topre/readme.md
@@ -0,0 +1,25 @@
+# OSAv2 Topre
+
+![osav2_topre](https://i.imgur.com/WTRrpQFh.png)
+
+- Keyboard Maintainer: BlindAssassin111
+- Hardware Supported: OSAv2 Topre PCBs
+- Hardware Availability: Viktus Design LLC
+
+Make example for this keyboard (after setting up your build environment):
+
+ make viktus/osav2_topre:default
+
+Flashing example for this keyboard:
+
+ make viktus/osav2_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