summaryrefslogtreecommitdiff
path: root/keyboards/kudox/columner/readme.md
diff options
context:
space:
mode:
authorくまお工房 <52371962+kumaokobo@users.noreply.github.com>2019-11-20 05:51:47 +0900
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2019-11-19 12:51:47 -0800
commitbb87bdec82433053eef68caa5fe4a03083a13e9c (patch)
tree6d726c80f221eb7fc3b446d36c4d435abdee5169 /keyboards/kudox/columner/readme.md
parent687a24f2980e6e490ac8e43104f4176b033c9243 (diff)
downloadqmk_firmware-bb87bdec82433053eef68caa5fe4a03083a13e9c.tar.gz
qmk_firmware-bb87bdec82433053eef68caa5fe4a03083a13e9c.zip
[Keyboard] Add Kudox column-staggered layout. (#7400)
* Add Kudox columner layout. * Remove an extra comma from info.json.
Diffstat (limited to 'keyboards/kudox/columner/readme.md')
-rw-r--r--keyboards/kudox/columner/readme.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/keyboards/kudox/columner/readme.md b/keyboards/kudox/columner/readme.md
new file mode 100644
index 0000000000..0c62174bcf
--- /dev/null
+++ b/keyboards/kudox/columner/readme.md
@@ -0,0 +1,32 @@
+# The Kudox Keyboard Columner
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/kumaokobo/kudox-keyboard/master/img/kudox.png" alt="Kudox logo" width="600"/>
+</p>
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/kumaokobo/kudox-keyboard/master/img/kudox-columner.jpg" alt="Kudox Columner" width="600"/>
+</p>
+
+- Keyboard Maintainer: [Kumao Kobo](https://github.com/kumaokobo)
+- Hardware Supported: Kudox Columner PCB rev1.0 w/ Pro Micro
+
+Make example for this keyboard (after setting up your build environment):
+
+```sh
+make kudox/columner:default
+```
+
+
+Example of flashing this keyboard:
+
+```sh
+make kudox/columner:default:flash
+```
+
+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).
+
+
+## Layout
+
+![layout](https://raw.githubusercontent.com/kumaokobo/kudox-keyboard/master/img/kudox-columner-layout-rev1.png)