summaryrefslogtreecommitdiffstats
path: root/keyboards/ut47/readme.md
diff options
context:
space:
mode:
authorCarlos <filoxo@users.noreply.github.com>2018-04-24 22:19:04 +0200
committerDrashna Jaelre <drashna@live.com>2018-04-24 22:19:04 +0200
commit32446eeeb6d846da4f3d742035eed7d49f91597d (patch)
treede5d5639ac34d2a91a5a9c0f61ee741be6cd18f5 /keyboards/ut47/readme.md
parent1feb42a1088e868cb963f35cc72d180733304db4 (diff)
downloadqmk_firmware-32446eeeb6d846da4f3d742035eed7d49f91597d.tar.gz
qmk_firmware-32446eeeb6d846da4f3d742035eed7d49f91597d.tar.xz
UT47 layout (#2791)
* Add new project files for UT47 * Copy over keymap and related files * Add LED_controls.ino * Add README instructions * Attempt sending press byte data * Disable mousekeys * Enable sending serial data to LED controller * Update LED mode names * Remove extra file * Add LED enable flag * Update READMEs with more info * Credit original author * Update copyrights * Update docs * Changed based on review * Move layout screenshot to Imgur * Append to src * Enable mousekeys to fix bad keycodes * Additional changes based on feedback * Fix fn layer keys
Diffstat (limited to 'keyboards/ut47/readme.md')
-rw-r--r--keyboards/ut47/readme.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/keyboards/ut47/readme.md b/keyboards/ut47/readme.md
new file mode 100644
index 000000000..3f08b3b32
--- /dev/null
+++ b/keyboards/ut47/readme.md
@@ -0,0 +1,41 @@
+# ut47
+
+![ut47](https://i.imgur.com/ZDKZQaj.jpg)
+
+Somewhere between ortholinear and standard offset. Created to have all the same functions on a Planck in a keyboard but with a more conventional keyboard row stagger.
+
+Keyboard Maintainer: [filoxo](https://github.com/filoxo), [network_operations]
+
+Hardware Supported: [PCB design](http://www.40percent.club/2016/10/gnap-20-plateless.html), Arduino Pro Micro
+
+Hardware Availability: [How to order](http://www.40percent.club/2017/03/ordering-pcb.html)
+
+### Instructions
+
+To flash the UT47 without LEDs (single controller), run:
+
+ make ut47:default
+
+To enable the UT47 LEDs (dual controller), run this for the main controller:
+
+ make ut47:default LED_ENABLE=yes
+
+Or you can add `LED_ENABLE = yes` to *rules.mk*
+
+And then flash [LED_controls.ino](LED_controls.ino) to the second controller using [Arduino IDE](https://www.arduino.cc/en/Main/Software) or similar. NOTE: Arduino IDE will require importing additional libraries to compile.
+
+<small>The reason this is an "opt-in" feature is to prevent sending serial communication over the pin, in case it ends up being used for something else (like RGB underglow).</small>
+
+### Layout
+
+Go to the [default layout README](keymaps/default/readme.md) for more information.
+
+### Additional info
+
+Credit: Forked from [di0ib TMK version](https://github.com/di0ib/tmk_keyboard/tree/master/keyboard/gnap)
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+
+### Build Guide
+
+[u/network_operations' build guide thread](https://www.reddit.com/r/MechanicalKeyboards/comments/7wqktu/gnap_the_cheap_40/)