summaryrefslogtreecommitdiff
path: root/keyboards/teleport/native/readme.md
diff options
context:
space:
mode:
authorebastler <moritz.plattner@gmx.net>2022-12-21 11:03:50 +0100
committerGitHub <noreply@github.com>2022-12-21 21:03:50 +1100
commitb8a9de206d38f0e047c2f07bca398d6fe53b76a9 (patch)
treedc963a9603fd9dec74a6fab18c0ca3589a11e911 /keyboards/teleport/native/readme.md
parentc0e54737ad98aedf06ab45d29a2639a97985d56c (diff)
Add Anvil Native keyboard (#19333)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/teleport/native/readme.md')
-rw-r--r--keyboards/teleport/native/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/teleport/native/readme.md b/keyboards/teleport/native/readme.md
new file mode 100644
index 0000000000..9ac1034fef
--- /dev/null
+++ b/keyboards/teleport/native/readme.md
@@ -0,0 +1,29 @@
+# Anvil Native
+
+The Native is a hot-swap 75% board with per-key LED ligthing in the Anvil brand lineup.
+
+* Keyboard maintainer: [ebastler](https://github.com/ebastler)
+* Hardware supported: Anvil Native ISO/ANSI
+* Hardware availability: Buy at [nvil.gg](https://www.nvil.gg/products/native-custom-keyboard-iso-de-ansi-de)
+
+Enter Bootloader:
+
+* Bootmagic: Keep ESC (top left key) pressed while plugging the board in
+* Physical reset button on the bottom of the PCB
+
+Make example for this keyboard (after setting up your build environment):
+
+ qmk compile -kb teleport/native/iso -km default
+ qmk compile -kb teleport/native/ansi -km default
+
+If you want the default keymap with all features present on the board when sold, pick the `perfmode` keymaps instead:
+
+ qmk compile -kb teleport/native/iso -km perfmode
+ qmk compile -kb teleport/native/ansi -km perfmode
+
+Flash example for this keyboard:
+
+ qmk flash -kb teleport/native/iso -km default
+ qmk flash -kb teleport/native/ansi -km default
+
+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).