summaryrefslogtreecommitdiff
path: root/keyboards/jiran/readme.md
diff options
context:
space:
mode:
authorLadniy <32298096+Ladniy@users.noreply.github.com>2020-07-28 08:48:48 +0800
committerGitHub <noreply@github.com>2020-07-27 17:48:48 -0700
commit84cd07b0d3409d1bbb72691fd79c8a9a885363a0 (patch)
tree40328fd3625287241e24f2afd1382a513cc026fa /keyboards/jiran/readme.md
parent6104609afa666750be49ccfa8df8d3ad87fb4f32 (diff)
[Keyboard] Jiran keyboard (#9628)
* Add jirand folder from local catalog * Add controller into readme * Replace image of PCB * Create rev2 folder for RGB version * Rename keymap folder * Add new rev for RGB light version * Change some keycodes for RGB light * Remove some unnecessary code * Add via keymap * Activate RBG light support * Update some info * Update layout image link * Update keyboards/jiran/config.h * Update keyboards/jiran/keymaps/via/config.h * Update keyboards/jiran/keymaps/default/rules.mk * Update keyboards/jiran/keymaps/default/readme.md * Update keyboards/jiran/keymaps/default/keymap.c * Update keyboards/jiran/rev1/config.h * Update keyboards/jiran/rev1/config.h * Update keyboards/jiran/rules.mk * Update keyboards/jiran/rules.mk * Update keyboards/jiran/rules.mk * Update keyboards/jiran/rev2/config.h * Update keyboards/jiran/rev2/config.h * Update keyboards/jiran/rules.mk * Update keyboards/jiran/rev2/rev1.c * Update keyboards/jiran/rules.mk * Update keyboards/jiran/rules.mk * Update keyboards/jiran/rules.mk * Some fix * Update keyboards/jiran/keymaps/default/keymap.c * Update keyboards/jiran/rev1/config.h * Update keyboards/jiran/rev1/config.h * Update keyboards/jiran/rev2/config.h * Fix default keymap error * Update keyboards/jiran/rules.mk * Update keyboards/jiran/rev2/rules.mk * Update keyboards/jiran/rev1/rules.mk * Update keyboards/jiran/config.h * Update keyboards/jiran/rev1/config.h * Update keyboards/jiran/rev2/config.h * Delete by request * Update keyboards/jiran/config.h * Update keyboards/jiran/keymaps/via/keymap.c * Update keyboards/jiran/rules.mk * Update keyboards/jiran/rules.mk * Update keyboards/jiran/rules.mk * Change some info by request * Update keyboards/jiran/rev1/rev1.h * Remove by request
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