summaryrefslogtreecommitdiffstats
path: root/keyboards/kona_classic/README.md
diff options
context:
space:
mode:
authorDangerousParts <DangerousParts@gmail.com>2017-11-01 04:59:23 +0100
committerJack Humbert <jack.humb@gmail.com>2017-11-01 04:59:23 +0100
commit20e18d15e3173e342336d99ee0f7ed76392af190 (patch)
tree40d52bf95fde6cdd05ca2e755582ae1154e3b598 /keyboards/kona_classic/README.md
parent83af62322cfe8cbe23f404ec5fa857679dc44cea (diff)
downloadqmk_firmware-20e18d15e3173e342336d99ee0f7ed76392af190.tar.gz
qmk_firmware-20e18d15e3173e342336d99ee0f7ed76392af190.tar.xz
Created Kona Classic config (#1791)
* Created Kona Classic config * Fixed KonaClassic config * Updated README * Updated Readme to conform to format standards * Added ANSI and ISO layout options * Fixed images in Readme * Added labels to images * Added absolute links to images in Readme * Image link updates again * Fixed bottom row keys in some layouts * Fixed Grave and Tilde * Fixed Underglow in Kona Classic configs * Renamed KonaClassic to kona_classic
Diffstat (limited to 'keyboards/kona_classic/README.md')
-rw-r--r--keyboards/kona_classic/README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/keyboards/kona_classic/README.md b/keyboards/kona_classic/README.md
new file mode 100644
index 000000000..5821e0562
--- /dev/null
+++ b/keyboards/kona_classic/README.md
@@ -0,0 +1,47 @@
+Kona Classic
+===
+
+![Kona Classic](http://i.imgur.com/7twIpuB.jpg)
+
+
+The Kona Classic is a 60% layout + left Function keys. Using a Teensy as the controller, the Kona Classic is provided as a do-it-yourself kit for left f-key enthusiasts.
+
+Keyboard Maintainer: [Maximillian Hill](https://github.com/DangerousParts)
+Hardware Supported: Teensy 2.0
+Hardware Availability: Via GB
+
+Layouts that are preconfigured are shown here:
+
+Default:
+![Default](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/default.png)
+
+ANSI:
+![ANSI](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi.png)
+
+ANSI_split:
+![ANSI w/ Split Space](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi_split.png)
+
+ANSI_arrows:
+![ANSI w/ Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi_arrows.png)
+
+ANSI_split_arrows:
+![ANSI w/ Split Space & Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/ansi_split_arrows.png)
+
+ISO:
+![ISO](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso.png)
+
+ISO_split:
+![ISO w/ Split Space](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso_split.png)
+
+ISO_arrows:
+![ISO w/ Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso_arrows.png)
+
+ISO_split_arrows:
+![ISO w/ Split Space & Arrows](https://github.com/DangerousParts/KonaClassic/blob/master/QMKFirmware/layout_images/iso_split_arrows.png)
+
+
+Make example for this keyboard (after setting up your build environment):
+
+ make KonaClassic-default
+
+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. \ No newline at end of file