summaryrefslogtreecommitdiffstats
path: root/keyboards/durgod/k310/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/durgod/k310/readme.md')
-rw-r--r--keyboards/durgod/k310/readme.md29
1 files changed, 27 insertions, 2 deletions
diff --git a/keyboards/durgod/k310/readme.md b/keyboards/durgod/k310/readme.md
index 234fcc875d..1f39f79513 100644
--- a/keyboards/durgod/k310/readme.md
+++ b/keyboards/durgod/k310/readme.md
@@ -1,4 +1,29 @@
-# K310
+# Taurus K310
-See: [K310](../k3x0/k310/readme.md)
+This code is shared between all K310 variants. Currently only the base model with no backlight is supported.
+This is a standard off-the-shelf Durgod Taurus K310 full-sized 104/105-key
+keyboard without backlight. This supports both the ANSI and ISO variants.
+
+* Keyboard Maintainers: [dkjer](https://github.com/dkjer) and [tylert](https://github.com/tylert)
+* Hardware Supported: [Durgod Taurus K310 board with STM32F070RBT6](https://www.durgod.com/page9?product_id=53&_l=en "Durgod.com Product Page")
+* Hardware Availability: [Amazon.com](https://www.amazon.com/Durgod-Taurus-K310-Mechanical-Keyboard/dp/B07TXB4XF3)
+
+## Instructions
+
+### Build
+
+Make command example for this keyboard (after setting up your build environment):
+
+ make durgod/k310/base:default
+
+Flashing example for this keyboard:
+
+ make durgod/k310/base: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).
+
+### Initial Flash
+
+Instructions for Flashing from initial Stock Firmware:
+* [Initial Flashing](../k3x0/readme.md#initial-flash)