summaryrefslogtreecommitdiff
path: root/keyboards/xelus/dharma/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/xelus/dharma/readme.md')
-rw-r--r--keyboards/xelus/dharma/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/xelus/dharma/readme.md b/keyboards/xelus/dharma/readme.md
new file mode 100644
index 0000000000..37d06356a9
--- /dev/null
+++ b/keyboards/xelus/dharma/readme.md
@@ -0,0 +1,20 @@
+# Dharma
+
+A Mini 1800 - esque keyboard by [Janglad](https://qoda.studio/dharma/)
+
+* Keyboard Maintainer: [Xelus22](https://github.com/Xelus22)
+* Hardware Supported: Dharma
+* Hardware Availability: Custom keyboard group buys
+
+Make example for this keyboard (after setting up your build environment):
+
+ make xelus/dharma:default
+
+Reset your keyboard in 3 ways:
+<ol>
+<li>Software reset on Fn + Backspace</li>
+<li>Bootmagic reset: hold down the top left key (usually escape) and plugin the keyboard</li>
+<li>Physical reset button: on the back of the PCB, use tweezers and short RST and GND together</li>
+</ol>
+
+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).