From a8b13318b9201b8447b4b4338cd3538cf887bf71 Mon Sep 17 00:00:00 2001 From: Frederik Baerentsen Date: Tue, 7 Jul 2020 10:19:57 +0200 Subject: [PATCH] Update 'readme.md' --- readme.md | 52 ++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 40 insertions(+), 12 deletions(-) diff --git a/readme.md b/readme.md index 6092f209..dffb05e6 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,43 @@ # Quantum Mechanical Keyboard Firmware +> This is a fork of the official [GitHub Repo](https://github.com/qmk/qmk_firmware) of QMK. +> This repo only contains userspace for my layouts and the layouts themselves. + + +## Boards + +The repo only contains keymaps for my own boards. The keymaps can be changed to other layouts as well. + +### Current + +* [Melody96](FrederikBaerentsen/QMK/src/branch/master/keyboards/melody96) +* [UT47.5](FrederikBaerentsen/QMK/src/branch/master/keyboards/ut472) +* [Kyria](FrederikBaerentsen/QMK/src/branch/master/keyboards/kyria) + +### Incoming + +* [Lily58](FrederikBaerentsen/QMK/src/branch/master/keyboards/lily58) (Est. Q2) +* [SPACE65:CyberVoyager](https://graystudio.club/) (Est. Q3/Q4) +* [Rukia R2](https://www.mintautumn.com/) (Est. Q4) +* [Klippe T R4](https://mekanisk.co/) (Est. Q3) +* [ElectroType Acrylic Alice](https://switchcouture.com/) (Est. Q2/Q3) +* [Uno](https://www.reddit.com/r/mechmarket/comments/gyijm7/gb_uno/) (Est. Q3) + + +## Keymaps + +All my keymaps are based on the userspace from [Drashna](https://github.com/qmk/qmk_firmware/tree/master/users/drashna). This is probably the most advanced userspace I've seen and I have heavily borrowed from it (read: copy/paste). + +## Keyboard-layout-editor + +All the boards should be available on keyboard-layout-editor.com. + +* [Kyria](http://www.keyboard-layout-editor.com/#/gists/e0a6bd87b1e727555ec5c5c1b82c3670) +* [Lily58](http://www.keyboard-layout-editor.com/#/gists/ef22a088bdb96962de3b8b5ae4cd3951) +* [UT47.2](http://www.keyboard-layout-editor.com/#/gists/5ab8838c07cdb2fc41f3dd9a8b177bf4) +* [Melody96](http://www.keyboard-layout-editor.com/#/gists/8a16447546079e942b151523ac2356b8) + +# Official QMK Information +Below is information about the official [GitHub Repo](https://github.com/qmk/qmk_firmware) [![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags) [![Build Status](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware) @@ -13,21 +52,10 @@ This is a keyboard firmware based on the [tmk\_keyboard firmware](https://github * [See the official documentation on docs.qmk.fm](https://docs.qmk.fm) -The docs are powered by [Docsify](https://docsify.js.org/) and hosted on [GitHub](/docs/). They are also viewable offline; see [Previewing the Documentation](https://docs.qmk.fm/#/contributing?id=previewing-the-documentation) for more details. +The docs are powered by [Docsify](https://docsify.js.org/) and hosted on [GitHub](https://github.com/qmk/qmk_firmware/docs/). They are also viewable offline; see [Previewing the Documentation](https://docs.qmk.fm/#/contributing?id=previewing-the-documentation) for more details. You can request changes by making a fork and opening a [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "Edit this page" link at the bottom of any page. -## Supported Keyboards - -* [Planck](/keyboards/planck/) -* [Preonic](/keyboards/preonic/) -* [ErgoDox EZ](/keyboards/ergodox_ez/) -* [Clueboard](/keyboards/clueboard/) -* [Cluepad](/keyboards/clueboard/17/) -* [Atreus](/keyboards/atreus/) - -The project also includes community support for [lots of other keyboards](/keyboards/). - ## Maintainers QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [ZSA Technology Labs](https://github.com/zsa), the Clueboard by [Zach White](https://github.com/skullydazed), and the Atreus by [Phil Hagelberg](https://github.com/technomancy).