summaryrefslogtreecommitdiffstats
path: root/keyboards/bastardkb/scylla/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/bastardkb/scylla/readme.md')
-rw-r--r--keyboards/bastardkb/scylla/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/bastardkb/scylla/readme.md b/keyboards/bastardkb/scylla/readme.md
new file mode 100644
index 0000000000..830b8eacda
--- /dev/null
+++ b/keyboards/bastardkb/scylla/readme.md
@@ -0,0 +1,29 @@
+# Scylla
+
+A modern, low-profile split ergonomic keyboard
+
+* Keyboard Maintainer: [Bastard Keyboards](https://github.com/Bastardkb/)
+* Hardware Supported: elite-C V4
+* Hardware Availability: [Bastard Keyboards](https://bastardkb.com/)
+
+## Building the firmware
+
+**You must specify the shield version when compiling/flashing the firmware.**
+
+The template is:
+
+```shell
+qmk compile -kb bastardkb/scylla/{VERSION}/elitec -km {KEYMAP}
+```
+
+| Shield Version | default | via |
+| --------------- | ------------------------------------------------------------- | --------------------------------------------------------- |
+| v1 (Elite-C) | `qmk compile -kb bastardkb/scylla/v1/elitec -km default` | `qmk compile -kb bastardkb/scylla/v1/elitec -km via` |
+| v2 (Elite-C) | `qmk compile -kb bastardkb/scylla/v2/elitec -km default` | `qmk compile -kb bastardkb/scylla/v2/elitec -km via` |
+| v2 (Splinky v2) | `qmk compile -kb bastardkb/scylla/v2/splinky/v2 -km default` | `qmk compile -kb bastardkb/scylla/v2/splinky/v2 -km via` |
+| v2 (Splinky v3) | `qmk compile -kb bastardkb/scylla/v2/splinky/v3 -km default` | `qmk compile -kb bastardkb/scylla/v2/splinky/v3 -km via` |
+| v2 (STeMCell) | `qmk compile -kb bastardkb/scylla/v2/stemcell -km default` | `qmk compile -kb bastardkb/scylla/v2/stemcell -km via` |
+
+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).
+
+See the [keyboard build instructions](https://docs.bastardkb.com)