summaryrefslogtreecommitdiffstats
path: root/keyboards/lucid/velvet_solder/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/lucid/velvet_solder/readme.md')
-rw-r--r--keyboards/lucid/velvet_solder/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/lucid/velvet_solder/readme.md b/keyboards/lucid/velvet_solder/readme.md
new file mode 100644
index 0000000000..83fd074047
--- /dev/null
+++ b/keyboards/lucid/velvet_solder/readme.md
@@ -0,0 +1,20 @@
+# Velvet Solder PCB by Lucid
+
+The following is the QMK Firmware for the Velvet Solder PCB by [Maker Keyboards](http://www.makerkeyboards.com).
+* Keyboard Maintainer: Maker Keyboards
+* Hardware Supported: Velvet
+
+Make example for this keyboard (after setting up your build environment):
+
+ make lucid/velvet_solder: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).
+
+## Bootloader
+
+Enter the bootloader in 2 ways:
+
+* **Bootmagic reset**: Hold down the top left key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available (Fn+Backslash by 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).