summaryrefslogtreecommitdiff
path: root/keyboards/jiran/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/jiran/readme.md')
-rw-r--r--keyboards/jiran/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/jiran/readme.md b/keyboards/jiran/readme.md
new file mode 100644
index 0000000000..13dc8963df
--- /dev/null
+++ b/keyboards/jiran/readme.md
@@ -0,0 +1,15 @@
+# Jiran
+
+![Jiran](https://i.imgur.com/HnA2Onc.png)
+
+A 6x4 matrix ergo keyboard with additional 3 thumb and 1 pinky keys for full cyrillic layout. [More info on GitHub](https://github.com/Ladniy/jiran-breakoff)
+
+* Keyboard Maintainer: [Ladniy](https://github.com/Ladniy)
+* Hardware Supported: Jiran PCB rev1, rev2, Pro Micro
+* Hardware Availability: [Open Source](https://github.com/Ladniy/jiran-breakoff)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make jiran: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). \ No newline at end of file