From ad86894ae7d5fbb7aed697d9f576cd186bfd1c9c Mon Sep 17 00:00:00 2001 From: Erovia Date: Sun, 25 Oct 2020 15:23:42 +0000 Subject: Rename keyboard-level readmes to lower-case (#10759) This is the recommendation in the [PR Checklist](https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs) and it will make working with them easier in the CLI/API/etc. --- keyboards/4pplet/aekiso60/README.md | 14 -- keyboards/4pplet/aekiso60/readme.md | 14 ++ keyboards/4pplet/steezy60/README.md | 14 -- keyboards/4pplet/steezy60/readme.md | 14 ++ keyboards/4pplet/waffling60/README.md | 14 -- keyboards/4pplet/waffling60/readme.md | 14 ++ keyboards/acheron/shark/README.md | 17 --- keyboards/acheron/shark/readme.md | 17 +++ keyboards/ai03/README.md | 4 - keyboards/ai03/readme.md | 4 + keyboards/aplx6/README.md | 41 ------ keyboards/aplx6/readme.md | 41 ++++++ keyboards/ashpil/modelm_usbc/README.md | 14 -- keyboards/ashpil/modelm_usbc/readme.md | 14 ++ keyboards/bemeier/bmek/README.md | 30 ---- keyboards/bemeier/bmek/readme.md | 30 ++++ keyboards/catch22/README.md | 17 --- keyboards/catch22/readme.md | 17 +++ keyboards/chili/README.md | 15 -- keyboards/chili/readme.md | 15 ++ keyboards/converter/adb_usb/README.md | 84 ----------- keyboards/converter/adb_usb/readme.md | 84 +++++++++++ keyboards/converter/m0110_usb/README.md | 51 ------- keyboards/converter/m0110_usb/readme.md | 51 +++++++ keyboards/converter/usb_usb/README.md | 69 --------- keyboards/converter/usb_usb/ble/README.md | 30 ---- keyboards/converter/usb_usb/ble/readme.md | 30 ++++ keyboards/converter/usb_usb/readme.md | 69 +++++++++ keyboards/converter/xt_usb/README.md | 17 --- keyboards/converter/xt_usb/readme.md | 17 +++ keyboards/db/db63/README.md | 21 --- keyboards/db/db63/readme.md | 21 +++ keyboards/fc660c/README.md | 167 --------------------- keyboards/fc660c/readme.md | 167 +++++++++++++++++++++ keyboards/fc980c/README.md | 185 ------------------------ keyboards/fc980c/readme.md | 185 ++++++++++++++++++++++++ keyboards/flehrad/bigswitch/README.md | 16 -- keyboards/flehrad/bigswitch/readme.md | 16 ++ keyboards/handwired/42/README.md | 15 -- keyboards/handwired/42/readme.md | 15 ++ keyboards/handwired/aplx2/README.md | 34 ----- keyboards/handwired/aplx2/readme.md | 34 +++++ keyboards/handwired/cans12er/README.md | 18 --- keyboards/handwired/cans12er/readme.md | 18 +++ keyboards/handwired/d48/README.md | 87 ----------- keyboards/handwired/d48/readme.md | 87 +++++++++++ keyboards/handwired/k8split/README.md | 21 --- keyboards/handwired/k8split/readme.md | 21 +++ keyboards/handwired/qc60/README.md | 21 --- keyboards/handwired/qc60/readme.md | 21 +++ keyboards/handwired/rs60/README.md | 27 ---- keyboards/handwired/rs60/readme.md | 27 ++++ keyboards/handwired/videowriter/README.md | 61 -------- keyboards/handwired/videowriter/readme.md | 61 ++++++++ keyboards/handwired/wulkan/README.md | 14 -- keyboards/handwired/wulkan/readme.md | 14 ++ keyboards/handwired/xealousbrown/README.md | 17 --- keyboards/handwired/xealousbrown/readme.md | 17 +++ keyboards/jj40/README.md | 21 --- keyboards/jj40/readme.md | 21 +++ keyboards/jj50/README.md | 21 --- keyboards/jj50/readme.md | 21 +++ keyboards/kabedon/kabedon78s/README.md | 13 -- keyboards/kabedon/kabedon78s/readme.md | 13 ++ keyboards/kabedon/kabedon980/README.md | 18 --- keyboards/kabedon/kabedon980/readme.md | 18 +++ keyboards/keebio/chocopad/README.md | 14 -- keyboards/keebio/chocopad/readme.md | 14 ++ keyboards/keebio/dilly/README.md | 14 -- keyboards/keebio/dilly/readme.md | 14 ++ keyboards/keebio/tragicforce68/README.md | 18 --- keyboards/keebio/tragicforce68/readme.md | 18 +++ keyboards/kinesis/nguyenvietyen/README.md | 109 -------------- keyboards/kinesis/nguyenvietyen/readme.md | 109 ++++++++++++++ keyboards/kingly_keys/soap/README.md | 16 -- keyboards/kingly_keys/soap/readme.md | 16 ++ keyboards/kona_classic/README.md | 47 ------ keyboards/kona_classic/readme.md | 47 ++++++ keyboards/lets_split_eh/README.md | 13 -- keyboards/lets_split_eh/readme.md | 13 ++ keyboards/mechmini/v1/README.md | 19 --- keyboards/mechmini/v1/readme.md | 19 +++ keyboards/mechmini/v2/README.md | 22 --- keyboards/mechmini/v2/readme.md | 22 +++ keyboards/mschwingen/modelm/README.md | 25 ---- keyboards/mschwingen/modelm/readme.md | 25 ++++ keyboards/noxary/README.md | 11 -- keyboards/noxary/readme.md | 11 ++ keyboards/nullbitsco/nibble/README.md | 19 --- keyboards/nullbitsco/nibble/readme.md | 19 +++ keyboards/percent/skog/README.md | 17 --- keyboards/percent/skog/readme.md | 17 +++ keyboards/switchplate/README.md | 4 - keyboards/switchplate/readme.md | 4 + keyboards/terrazzo/README.md | 125 ---------------- keyboards/terrazzo/readme.md | 125 ++++++++++++++++ keyboards/thevankeyboards/bananasplit/README.md | 14 -- keyboards/thevankeyboards/bananasplit/readme.md | 14 ++ keyboards/tkc/m0lly/README.md | 17 --- keyboards/tkc/m0lly/readme.md | 17 +++ keyboards/tkc/osav2/README.md | 15 -- keyboards/tkc/osav2/readme.md | 15 ++ keyboards/tkc/tkc1800/README.md | 17 --- keyboards/tkc/tkc1800/readme.md | 17 +++ keyboards/wheatfield/split75/README.md | 28 ---- keyboards/wheatfield/split75/readme.md | 28 ++++ keyboards/winkeyless/bface/README.md | 19 --- keyboards/winkeyless/bface/readme.md | 19 +++ keyboards/xiaomi/mk02/README.md | 104 ------------- keyboards/xiaomi/mk02/readme.md | 104 +++++++++++++ keyboards/ymd75/README.md | 22 --- keyboards/ymd75/readme.md | 22 +++ keyboards/ymdk/bface/README.md | 22 --- keyboards/ymdk/bface/readme.md | 22 +++ keyboards/ymdk/ymd09/README.md | 15 -- keyboards/ymdk/ymd09/readme.md | 15 ++ 116 files changed, 1954 insertions(+), 1954 deletions(-) delete mode 100644 keyboards/4pplet/aekiso60/README.md create mode 100644 keyboards/4pplet/aekiso60/readme.md delete mode 100644 keyboards/4pplet/steezy60/README.md create mode 100644 keyboards/4pplet/steezy60/readme.md delete mode 100644 keyboards/4pplet/waffling60/README.md create mode 100644 keyboards/4pplet/waffling60/readme.md delete mode 100644 keyboards/acheron/shark/README.md create mode 100644 keyboards/acheron/shark/readme.md delete mode 100644 keyboards/ai03/README.md create mode 100644 keyboards/ai03/readme.md delete mode 100644 keyboards/aplx6/README.md create mode 100644 keyboards/aplx6/readme.md delete mode 100644 keyboards/ashpil/modelm_usbc/README.md create mode 100644 keyboards/ashpil/modelm_usbc/readme.md delete mode 100755 keyboards/bemeier/bmek/README.md create mode 100755 keyboards/bemeier/bmek/readme.md delete mode 100644 keyboards/catch22/README.md create mode 100644 keyboards/catch22/readme.md delete mode 100644 keyboards/chili/README.md create mode 100644 keyboards/chili/readme.md delete mode 100644 keyboards/converter/adb_usb/README.md create mode 100644 keyboards/converter/adb_usb/readme.md delete mode 100644 keyboards/converter/m0110_usb/README.md create mode 100644 keyboards/converter/m0110_usb/readme.md delete mode 100644 keyboards/converter/usb_usb/README.md delete mode 100644 keyboards/converter/usb_usb/ble/README.md create mode 100644 keyboards/converter/usb_usb/ble/readme.md create mode 100644 keyboards/converter/usb_usb/readme.md delete mode 100644 keyboards/converter/xt_usb/README.md create mode 100644 keyboards/converter/xt_usb/readme.md delete mode 100644 keyboards/db/db63/README.md create mode 100644 keyboards/db/db63/readme.md delete mode 100644 keyboards/fc660c/README.md create mode 100644 keyboards/fc660c/readme.md delete mode 100644 keyboards/fc980c/README.md create mode 100644 keyboards/fc980c/readme.md delete mode 100644 keyboards/flehrad/bigswitch/README.md create mode 100644 keyboards/flehrad/bigswitch/readme.md delete mode 100644 keyboards/handwired/42/README.md create mode 100644 keyboards/handwired/42/readme.md delete mode 100644 keyboards/handwired/aplx2/README.md create mode 100644 keyboards/handwired/aplx2/readme.md delete mode 100644 keyboards/handwired/cans12er/README.md create mode 100644 keyboards/handwired/cans12er/readme.md delete mode 100644 keyboards/handwired/d48/README.md create mode 100644 keyboards/handwired/d48/readme.md delete mode 100644 keyboards/handwired/k8split/README.md create mode 100644 keyboards/handwired/k8split/readme.md delete mode 100644 keyboards/handwired/qc60/README.md create mode 100644 keyboards/handwired/qc60/readme.md delete mode 100644 keyboards/handwired/rs60/README.md create mode 100644 keyboards/handwired/rs60/readme.md delete mode 100644 keyboards/handwired/videowriter/README.md create mode 100644 keyboards/handwired/videowriter/readme.md delete mode 100644 keyboards/handwired/wulkan/README.md create mode 100644 keyboards/handwired/wulkan/readme.md delete mode 100644 keyboards/handwired/xealousbrown/README.md create mode 100644 keyboards/handwired/xealousbrown/readme.md delete mode 100644 keyboards/jj40/README.md create mode 100644 keyboards/jj40/readme.md delete mode 100644 keyboards/jj50/README.md create mode 100644 keyboards/jj50/readme.md delete mode 100644 keyboards/kabedon/kabedon78s/README.md create mode 100644 keyboards/kabedon/kabedon78s/readme.md delete mode 100644 keyboards/kabedon/kabedon980/README.md create mode 100644 keyboards/kabedon/kabedon980/readme.md delete mode 100644 keyboards/keebio/chocopad/README.md create mode 100644 keyboards/keebio/chocopad/readme.md delete mode 100644 keyboards/keebio/dilly/README.md create mode 100644 keyboards/keebio/dilly/readme.md delete mode 100644 keyboards/keebio/tragicforce68/README.md create mode 100644 keyboards/keebio/tragicforce68/readme.md delete mode 100644 keyboards/kinesis/nguyenvietyen/README.md create mode 100644 keyboards/kinesis/nguyenvietyen/readme.md delete mode 100644 keyboards/kingly_keys/soap/README.md create mode 100644 keyboards/kingly_keys/soap/readme.md delete mode 100644 keyboards/kona_classic/README.md create mode 100644 keyboards/kona_classic/readme.md delete mode 100644 keyboards/lets_split_eh/README.md create mode 100644 keyboards/lets_split_eh/readme.md delete mode 100644 keyboards/mechmini/v1/README.md create mode 100644 keyboards/mechmini/v1/readme.md delete mode 100644 keyboards/mechmini/v2/README.md create mode 100644 keyboards/mechmini/v2/readme.md delete mode 100644 keyboards/mschwingen/modelm/README.md create mode 100644 keyboards/mschwingen/modelm/readme.md delete mode 100644 keyboards/noxary/README.md create mode 100644 keyboards/noxary/readme.md delete mode 100644 keyboards/nullbitsco/nibble/README.md create mode 100644 keyboards/nullbitsco/nibble/readme.md delete mode 100644 keyboards/percent/skog/README.md create mode 100644 keyboards/percent/skog/readme.md delete mode 100644 keyboards/switchplate/README.md create mode 100644 keyboards/switchplate/readme.md delete mode 100644 keyboards/terrazzo/README.md create mode 100644 keyboards/terrazzo/readme.md delete mode 100644 keyboards/thevankeyboards/bananasplit/README.md create mode 100644 keyboards/thevankeyboards/bananasplit/readme.md delete mode 100644 keyboards/tkc/m0lly/README.md create mode 100644 keyboards/tkc/m0lly/readme.md delete mode 100644 keyboards/tkc/osav2/README.md create mode 100644 keyboards/tkc/osav2/readme.md delete mode 100644 keyboards/tkc/tkc1800/README.md create mode 100644 keyboards/tkc/tkc1800/readme.md delete mode 100644 keyboards/wheatfield/split75/README.md create mode 100644 keyboards/wheatfield/split75/readme.md delete mode 100644 keyboards/winkeyless/bface/README.md create mode 100644 keyboards/winkeyless/bface/readme.md delete mode 100644 keyboards/xiaomi/mk02/README.md create mode 100644 keyboards/xiaomi/mk02/readme.md delete mode 100644 keyboards/ymd75/README.md create mode 100644 keyboards/ymd75/readme.md delete mode 100644 keyboards/ymdk/bface/README.md create mode 100644 keyboards/ymdk/bface/readme.md delete mode 100644 keyboards/ymdk/ymd09/README.md create mode 100644 keyboards/ymdk/ymd09/readme.md diff --git a/keyboards/4pplet/aekiso60/README.md b/keyboards/4pplet/aekiso60/README.md deleted file mode 100644 index 42c3d3421d..0000000000 --- a/keyboards/4pplet/aekiso60/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# AEKISO60 - -A 60% PCB enabling use of ISO AEK keycaps and ALPS switches - -More info: https://geekhack.org/index.php?topic=103627.0 - -* Keyboard Maintainer: [4pplet](https://github.com/4pplet) -* Hardware Supported: AEKISO60 Rev A - -Make example for this keyboard (after setting up your build environment): - - make 4pplet/aekiso60/rev_a: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 diff --git a/keyboards/4pplet/aekiso60/readme.md b/keyboards/4pplet/aekiso60/readme.md new file mode 100644 index 0000000000..42c3d3421d --- /dev/null +++ b/keyboards/4pplet/aekiso60/readme.md @@ -0,0 +1,14 @@ +# AEKISO60 + +A 60% PCB enabling use of ISO AEK keycaps and ALPS switches + +More info: https://geekhack.org/index.php?topic=103627.0 + +* Keyboard Maintainer: [4pplet](https://github.com/4pplet) +* Hardware Supported: AEKISO60 Rev A + +Make example for this keyboard (after setting up your build environment): + + make 4pplet/aekiso60/rev_a: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 diff --git a/keyboards/4pplet/steezy60/README.md b/keyboards/4pplet/steezy60/README.md deleted file mode 100644 index 34245b84ef..0000000000 --- a/keyboards/4pplet/steezy60/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# Steezy60 - -A 60% PCB with a ton of layout options for SMK and Alps switches - -More info: https://geekhack.org/index.php?topic=103531.0 - -* Keyboard Maintainer: [4pplet](https://github.com/4pplet) -* Hardware Supported: Steezy60 Rev A - -Make example for this keyboard (after setting up your build environment): - - make 4pplet/steezy60/rev_a: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 diff --git a/keyboards/4pplet/steezy60/readme.md b/keyboards/4pplet/steezy60/readme.md new file mode 100644 index 0000000000..34245b84ef --- /dev/null +++ b/keyboards/4pplet/steezy60/readme.md @@ -0,0 +1,14 @@ +# Steezy60 + +A 60% PCB with a ton of layout options for SMK and Alps switches + +More info: https://geekhack.org/index.php?topic=103531.0 + +* Keyboard Maintainer: [4pplet](https://github.com/4pplet) +* Hardware Supported: Steezy60 Rev A + +Make example for this keyboard (after setting up your build environment): + + make 4pplet/steezy60/rev_a: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 diff --git a/keyboards/4pplet/waffling60/README.md b/keyboards/4pplet/waffling60/README.md deleted file mode 100644 index a6b56a69ea..0000000000 --- a/keyboards/4pplet/waffling60/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# waffling60 - -A 60% PCB for MX switches, one hot swap and one solder-pcb version with decent layout support. - -More info: https://geekhack.org/index.php?topic=103531.0 - -* Keyboard Maintainer: [4pplet](https://github.com/4pplet) -* Hardware Supported: [waffling60](https://github.com/4pplet/waffling60) - -Make example for this keyboard (after setting up your build environment): - - make 4pplet/steezy60/rev_a: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 diff --git a/keyboards/4pplet/waffling60/readme.md b/keyboards/4pplet/waffling60/readme.md new file mode 100644 index 0000000000..a6b56a69ea --- /dev/null +++ b/keyboards/4pplet/waffling60/readme.md @@ -0,0 +1,14 @@ +# waffling60 + +A 60% PCB for MX switches, one hot swap and one solder-pcb version with decent layout support. + +More info: https://geekhack.org/index.php?topic=103531.0 + +* Keyboard Maintainer: [4pplet](https://github.com/4pplet) +* Hardware Supported: [waffling60](https://github.com/4pplet/waffling60) + +Make example for this keyboard (after setting up your build environment): + + make 4pplet/steezy60/rev_a: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 diff --git a/keyboards/acheron/shark/README.md b/keyboards/acheron/shark/README.md deleted file mode 100644 index 962a73c6d1..0000000000 --- a/keyboards/acheron/shark/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Acheron Aχξρων 40-SM-O-MX-TH-WI (Codename "SharkPCB") QMK firmware - -

- -

- -This is the QMK firmware repository for the Shark, updated until [revision Alpha](https://github.com/Gondolindrim/SharkPCB/releases/tag/Alpha). - -The SharkPCB is an Open-Hardware guidelines compliant PCB which files can be found at [this link](https://github.com/Gondolindrim/SharkPCB). Its designer and maintainer is [Gondolindrim](https://github.com/Gondolindrim). - -See the [AcheronDocs](https://gondolindrim.github.io/AcheronDocs/shark/intro.html) page for the SharkPCB full documentation. - -Make example for this keyboard (after setting up your build environment): - - make acheron/shark: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). diff --git a/keyboards/acheron/shark/readme.md b/keyboards/acheron/shark/readme.md new file mode 100644 index 0000000000..962a73c6d1 --- /dev/null +++ b/keyboards/acheron/shark/readme.md @@ -0,0 +1,17 @@ +# Acheron Aχξρων 40-SM-O-MX-TH-WI (Codename "SharkPCB") QMK firmware + +

+ +

+ +This is the QMK firmware repository for the Shark, updated until [revision Alpha](https://github.com/Gondolindrim/SharkPCB/releases/tag/Alpha). + +The SharkPCB is an Open-Hardware guidelines compliant PCB which files can be found at [this link](https://github.com/Gondolindrim/SharkPCB). Its designer and maintainer is [Gondolindrim](https://github.com/Gondolindrim). + +See the [AcheronDocs](https://gondolindrim.github.io/AcheronDocs/shark/intro.html) page for the SharkPCB full documentation. + +Make example for this keyboard (after setting up your build environment): + + make acheron/shark: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). diff --git a/keyboards/ai03/README.md b/keyboards/ai03/README.md deleted file mode 100644 index 90bd219289..0000000000 --- a/keyboards/ai03/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# ai03 -QMK folders for PCB commissions. - -Website: [ai03 Keyboard Designs](https://kb.ai03.me/) \ No newline at end of file diff --git a/keyboards/ai03/readme.md b/keyboards/ai03/readme.md new file mode 100644 index 0000000000..90bd219289 --- /dev/null +++ b/keyboards/ai03/readme.md @@ -0,0 +1,4 @@ +# ai03 +QMK folders for PCB commissions. + +Website: [ai03 Keyboard Designs](https://kb.ai03.me/) \ No newline at end of file diff --git a/keyboards/aplx6/README.md b/keyboards/aplx6/README.md deleted file mode 100644 index 55e73ea2da..0000000000 --- a/keyboards/aplx6/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# Aplx6 - -![Front](https://i.imgur.com/flhSvAG.png) -![Back](https://i.imgur.com/PXqNmUh.png) - -A stylish (2x3) 6-key MediaPad for your music and browser shortcuts. Designed to be assembled as a sandwich with a blank PCB, using M2.5 screws and spacers, your choice of MX- or Alps-compatible switches, and 1N4148 diodes. - - -## RGB Underglow (WS2812) - -Just wire them to any of the unused ProMicro pins. Don't forget to edit-uncomment the `config.h` and the `rules.mk` for RGB underglow support, or even add your own functions and modes. Used pins can be found in `config.h` or in the [KiCad Schematic](https://github.com/Aplyard/Aplx6/blob/master/kiCad/xd6.sch). All ProMicro pins can be found [here](https://golem.hu/article/pro-micro-pinout/) along with the +2 pins mod. - -* Keyboard Maintainer: [Aplyard](https://github.com/Aplyard) -* Hardware Supported: Aplx6 PCB, Pro Micro (ATmega32U4) -* Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx6) - -Make example for this keyboard (after setting up your build environment): - - make aplx6: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). - ---- -****Designed in**:** -[KiCad](https://github.com/KiCad) - -**Components Footprints & Libraries :** -[keebs.pretty](https://github.com/egladman/keebs.pretty) -[keyboard_parts.pretty -](https://github.com/tmk/keyboard_parts.pretty) -[ProMicro KiCad](https://github.com/Biacco42/ProMicroKiCad) - -**Usefull Links:** -[Qmk Online Configurator](https://config.qmk.fm/#) - -**Alternatives of qmk that worked for me:** -[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/) -[Keyboard Plate & Case Builder](http://builder.swillkb.com/) -[Firmware Builder](https://kbfirmware.com/) - ---- diff --git a/keyboards/aplx6/readme.md b/keyboards/aplx6/readme.md new file mode 100644 index 0000000000..55e73ea2da --- /dev/null +++ b/keyboards/aplx6/readme.md @@ -0,0 +1,41 @@ +# Aplx6 + +![Front](https://i.imgur.com/flhSvAG.png) +![Back](https://i.imgur.com/PXqNmUh.png) + +A stylish (2x3) 6-key MediaPad for your music and browser shortcuts. Designed to be assembled as a sandwich with a blank PCB, using M2.5 screws and spacers, your choice of MX- or Alps-compatible switches, and 1N4148 diodes. + + +## RGB Underglow (WS2812) + +Just wire them to any of the unused ProMicro pins. Don't forget to edit-uncomment the `config.h` and the `rules.mk` for RGB underglow support, or even add your own functions and modes. Used pins can be found in `config.h` or in the [KiCad Schematic](https://github.com/Aplyard/Aplx6/blob/master/kiCad/xd6.sch). All ProMicro pins can be found [here](https://golem.hu/article/pro-micro-pinout/) along with the +2 pins mod. + +* Keyboard Maintainer: [Aplyard](https://github.com/Aplyard) +* Hardware Supported: Aplx6 PCB, Pro Micro (ATmega32U4) +* Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx6) + +Make example for this keyboard (after setting up your build environment): + + make aplx6: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). + +--- +****Designed in**:** +[KiCad](https://github.com/KiCad) + +**Components Footprints & Libraries :** +[keebs.pretty](https://github.com/egladman/keebs.pretty) +[keyboard_parts.pretty +](https://github.com/tmk/keyboard_parts.pretty) +[ProMicro KiCad](https://github.com/Biacco42/ProMicroKiCad) + +**Usefull Links:** +[Qmk Online Configurator](https://config.qmk.fm/#) + +**Alternatives of qmk that worked for me:** +[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/) +[Keyboard Plate & Case Builder](http://builder.swillkb.com/) +[Firmware Builder](https://kbfirmware.com/) + +--- diff --git a/keyboards/ashpil/modelm_usbc/README.md b/keyboards/ashpil/modelm_usbc/README.md deleted file mode 100644 index 261d97ab49..0000000000 --- a/keyboards/ashpil/modelm_usbc/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# USB C Model M - -![modelm_usbc](https://raw.githubusercontent.com/ashpil/Model-M-Type-C-Controller/master/images/render.png) - -This is a configuration of QMK intended to be used with the [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller "USB C Model M alt controller"). Many thanks to iw0rm3r for working on a similar project and providing the foundation for this! - -* Keyboard Maintainer: [ashpil](https://github.com/ashpil) -* Hardware Supported: [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller) - -Make example for this keyboard (after setting up your build environment): - - make ashpil/modelm_usbc: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). diff --git a/keyboards/ashpil/modelm_usbc/readme.md b/keyboards/ashpil/modelm_usbc/readme.md new file mode 100644 index 0000000000..261d97ab49 --- /dev/null +++ b/keyboards/ashpil/modelm_usbc/readme.md @@ -0,0 +1,14 @@ +# USB C Model M + +![modelm_usbc](https://raw.githubusercontent.com/ashpil/Model-M-Type-C-Controller/master/images/render.png) + +This is a configuration of QMK intended to be used with the [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller "USB C Model M alt controller"). Many thanks to iw0rm3r for working on a similar project and providing the foundation for this! + +* Keyboard Maintainer: [ashpil](https://github.com/ashpil) +* Hardware Supported: [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller) + +Make example for this keyboard (after setting up your build environment): + + make ashpil/modelm_usbc: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). diff --git a/keyboards/bemeier/bmek/README.md b/keyboards/bemeier/bmek/README.md deleted file mode 100755 index 3437a5afdd..0000000000 --- a/keyboards/bemeier/bmek/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# BMEK - -![BMEK](https://i.imgur.com/p1KFi6ql.jpg) - -BMEK combines the best of HHKB & Alice-likes. All PCB and case design files are open source. - -* Keyboard Maintainer: [Bemeier](https://github.com/Bemeier) -* Hardware Supported: BMEK PCB rev1, rev2, rev3 -* Hardware Availability: Case & PCB files: [github.com/bemeier/bmek](https://github.com/bemeier/bmek) - -Make example for this keyboard, for an hhkb-like layout and keymap (after setting up your build environment): - - make bemeier/bmek/rev3:default - -Make the VIA compatible firmware: - - make bemeier/bmek/rev3:via - -The ```rev3```, denotes the version of the PCB. -Check on the PCB to find out which version you have, and set it to rev1, rev2 or rev3 accordingly (the BMEK group buy PCBs are all rev3). - -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). - -# Layouts - -Starting with rev3 (the version of the PCB to be shipped in the GB), the following layout options are supported: - -![layouts](https://i.imgur.com/XuFxwthl.png) - -Note that the keymap shown above may not accurately reflect the default keymap of the firmware (see the keymaps folder). diff --git a/keyboards/bemeier/bmek/readme.md b/keyboards/bemeier/bmek/readme.md new file mode 100755 index 0000000000..3437a5afdd --- /dev/null +++ b/keyboards/bemeier/bmek/readme.md @@ -0,0 +1,30 @@ +# BMEK + +![BMEK](https://i.imgur.com/p1KFi6ql.jpg) + +BMEK combines the best of HHKB & Alice-likes. All PCB and case design files are open source. + +* Keyboard Maintainer: [Bemeier](https://github.com/Bemeier) +* Hardware Supported: BMEK PCB rev1, rev2, rev3 +* Hardware Availability: Case & PCB files: [github.com/bemeier/bmek](https://github.com/bemeier/bmek) + +Make example for this keyboard, for an hhkb-like layout and keymap (after setting up your build environment): + + make bemeier/bmek/rev3:default + +Make the VIA compatible firmware: + + make bemeier/bmek/rev3:via + +The ```rev3```, denotes the version of the PCB. +Check on the PCB to find out which version you have, and set it to rev1, rev2 or rev3 accordingly (the BMEK group buy PCBs are all rev3). + +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). + +# Layouts + +Starting with rev3 (the version of the PCB to be shipped in the GB), the following layout options are supported: + +![layouts](https://i.imgur.com/XuFxwthl.png) + +Note that the keymap shown above may not accurately reflect the default keymap of the firmware (see the keymaps folder). diff --git a/keyboards/catch22/README.md b/keyboards/catch22/README.md deleted file mode 100644 index 8d4a22398f..0000000000 --- a/keyboards/catch22/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Catch 22 Budget Hotswap Macropad - -GB by /u/rockydbull run in July 2018, PCB designed with help from /u/Kilgarah. - -Designed to be a budget project board to enjoy hotswapping/switch testing/macro making fun. The board is controlled by a pro micro clone made famous by other projects like the lets split, iris, and nyquist and allows for full QMK implementation. Each Catch22 kit will contain: - - * 2 pcbs (one to solder to and one to be a base)(green color) - * 1 pcb material switch plate( green color) with cut out for pcb mount cherry stabilizers - * 40 throughhole diodes (22 for the pcb and the remaining as extras in case you lose one and to use to make the pro micro removeable without desoldering) - * 22 Kailh hotswap sockets - * 1 smd reset button - * 1 dip socket to mount between the pcb and pro micro if you choose to make it removeable without desoldering - * 5 (12mm) m2 standoffs - * 10 m2 screws - * Genuine Cherry pcb mount 2u stabilizer - * 4 rubber bumpons - * Pro Micro is included in kit diff --git a/keyboards/catch22/readme.md b/keyboards/catch22/readme.md new file mode 100644 index 0000000000..8d4a22398f --- /dev/null +++ b/keyboards/catch22/readme.md @@ -0,0 +1,17 @@ +# Catch 22 Budget Hotswap Macropad + +GB by /u/rockydbull run in July 2018, PCB designed with help from /u/Kilgarah. + +Designed to be a budget project board to enjoy hotswapping/switch testing/macro making fun. The board is controlled by a pro micro clone made famous by other projects like the lets split, iris, and nyquist and allows for full QMK implementation. Each Catch22 kit will contain: + + * 2 pcbs (one to solder to and one to be a base)(green color) + * 1 pcb material switch plate( green color) with cut out for pcb mount cherry stabilizers + * 40 throughhole diodes (22 for the pcb and the remaining as extras in case you lose one and to use to make the pro micro removeable without desoldering) + * 22 Kailh hotswap sockets + * 1 smd reset button + * 1 dip socket to mount between the pcb and pro micro if you choose to make it removeable without desoldering + * 5 (12mm) m2 standoffs + * 10 m2 screws + * Genuine Cherry pcb mount 2u stabilizer + * 4 rubber bumpons + * Pro Micro is included in kit diff --git a/keyboards/chili/README.md b/keyboards/chili/README.md deleted file mode 100644 index a383f98fb0..0000000000 --- a/keyboards/chili/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# YDKB Chili - -[Chili PCB](https://i.imgur.com/fKi896a.jpg) - -The YDKB Chili is a Cherry G80-3000 replacement PCB utilizing the ATmega32U4 microcontroller. - -* Keyboard Maintainer: QMK community -* Hardware Supported: YDKB Chili -* Hardware Availability: [TaoBao](https://item.taobao.com/item.htm?id=565823984744) - -Make example for this keyboard (after setting up your build environment): - - make chili: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). diff --git a/keyboards/chili/readme.md b/keyboards/chili/readme.md new file mode 100644 index 0000000000..a383f98fb0 --- /dev/null +++ b/keyboards/chili/readme.md @@ -0,0 +1,15 @@ +# YDKB Chili + +[Chili PCB](https://i.imgur.com/fKi896a.jpg) + +The YDKB Chili is a Cherry G80-3000 replacement PCB utilizing the ATmega32U4 microcontroller. + +* Keyboard Maintainer: QMK community +* Hardware Supported: YDKB Chili +* Hardware Availability: [TaoBao](https://item.taobao.com/item.htm?id=565823984744) + +Make example for this keyboard (after setting up your build environment): + + make chili: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). diff --git a/keyboards/converter/adb_usb/README.md b/keyboards/converter/adb_usb/README.md deleted file mode 100644 index 8de9b9ad46..0000000000 --- a/keyboards/converter/adb_usb/README.md +++ /dev/null @@ -1,84 +0,0 @@ -ADB-to-USB Keyboard Converter -============================= -This firmware converts Apple Desktop Bus (ADB) keyboard protocol to USB so that you can use an ADB keyboard on a modern computer. It works on the PJRC Teensy 2.0 and other USB AVR MCUs (ATMega32U4, AT90USB64/128, etc) and needs at least 10KB of flash memory. - - -This is a port of the TMK ADB-to-USB converter to QMK. For information on QMK, please consult the following: -https://github.com/qmk/qmk_firmware -https://docs.qmk.fm - - -Wiring ------- -Connect the VCC, GND, and DATA lines of the ADB keyboard to the controller (Teensy 2.0 or similar). By default the DATA line uses port PD0. The Power SW line is unused by the converter. - -ADB female socket from the front: - - ,--_--. - / o4 3o \ 1: DATA - | o2 1o | 2: Power SW - - === - 3: VCC - `-___-' 4: GND - -This converter uses AVR's internal pull-up, but it seems to be too weak, in particular when you want to use a long or coiled cable. Using an external pull-up resistor (1K-10K Ohm) between the DATA and VCC lines is strongly recommended. - -Pull-up resistor: - - Keyboard Converter - ,------. - 5V------+------|VCC | - | | | - [R] | | - | | | - Signal--+------|PD0 | - | | - GND------------|GND | - `------' - R: 1K Ohm resistor - - -Define following macros for ADB connection in config.h if you use other than port PD0. - - ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT - - -Building the Firmware ------------------------------------------- -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). - - -Keymap ------- -To build the default keymap run this command: - - $ make converter/adb_usb:default - -You may add your own keymap to the converter/adb_usb/keymaps directory, as you would with any other QMK-powered keyboard. - -To build your custom keymap, change the build command to: - - $ make converter/adb_usb:my_keymap - -Where 'my_keymap' is the name of your custom keymap directory. - - -Locking Caps Lock ----------------- -Many old ADB keyboards use a locking switch for the caps lock key. This converter supports the locking caps lock key by default. - - -Notes ------ -Non-extended ADB keyboards make no distinction between the left and right modifiers, -i.e. the keycode for the left modifier will be sent even if the right modifier - -The Apple Extended Keyboard and Apple Extended Keyboard II can differentiate between the left and right modifiers except for the GUI key (Windows/Command). - -Most ADB keyboards have no diodes in its matrix so they are not NKRO, -though the ADB protocol itself supports it. See protocol/adb.c for more info. - - -QMK Port Changelog ---------- -- 2018/09/16 - Initial release. -- 2018/12/23 - Fixed lock LED support. diff --git a/keyboards/converter/adb_usb/readme.md b/keyboards/converter/adb_usb/readme.md new file mode 100644 index 0000000000..8de9b9ad46 --- /dev/null +++ b/keyboards/converter/adb_usb/readme.md @@ -0,0 +1,84 @@ +ADB-to-USB Keyboard Converter +============================= +This firmware converts Apple Desktop Bus (ADB) keyboard protocol to USB so that you can use an ADB keyboard on a modern computer. It works on the PJRC Teensy 2.0 and other USB AVR MCUs (ATMega32U4, AT90USB64/128, etc) and needs at least 10KB of flash memory. + + +This is a port of the TMK ADB-to-USB converter to QMK. For information on QMK, please consult the following: +https://github.com/qmk/qmk_firmware +https://docs.qmk.fm + + +Wiring +------ +Connect the VCC, GND, and DATA lines of the ADB keyboard to the controller (Teensy 2.0 or similar). By default the DATA line uses port PD0. The Power SW line is unused by the converter. + +ADB female socket from the front: + + ,--_--. + / o4 3o \ 1: DATA + | o2 1o | 2: Power SW + - === - 3: VCC + `-___-' 4: GND + +This converter uses AVR's internal pull-up, but it seems to be too weak, in particular when you want to use a long or coiled cable. Using an external pull-up resistor (1K-10K Ohm) between the DATA and VCC lines is strongly recommended. + +Pull-up resistor: + + Keyboard Converter + ,------. + 5V------+------|VCC | + | | | + [R] | | + | | | + Signal--+------|PD0 | + | | + GND------------|GND | + `------' + R: 1K Ohm resistor + + +Define following macros for ADB connection in config.h if you use other than port PD0. + + ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT + + +Building the Firmware +------------------------------------------ +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). + + +Keymap +------ +To build the default keymap run this command: + + $ make converter/adb_usb:default + +You may add your own keymap to the converter/adb_usb/keymaps directory, as you would with any other QMK-powered keyboard. + +To build your custom keymap, change the build command to: + + $ make converter/adb_usb:my_keymap + +Where 'my_keymap' is the name of your custom keymap directory. + + +Locking Caps Lock +---------------- +Many old ADB keyboards use a locking switch for the caps lock key. This converter supports the locking caps lock key by default. + + +Notes +----- +Non-extended ADB keyboards make no distinction between the left and right modifiers, +i.e. the keycode for the left modifier will be sent even if the right modifier + +The Apple Extended Keyboard and Apple Extended Keyboard II can differentiate between the left and right modifiers except for the GUI key (Windows/Command). + +Most ADB keyboards have no diodes in its matrix so they are not NKRO, +though the ADB protocol itself supports it. See protocol/adb.c for more info. + + +QMK Port Changelog +--------- +- 2018/09/16 - Initial release. +- 2018/12/23 - Fixed lock LED support. diff --git a/keyboards/converter/m0110_usb/README.md b/keyboards/converter/m0110_usb/README.md deleted file mode 100644 index 2e8a2eaef1..0000000000 --- a/keyboards/converter/m0110_usb/README.md +++ /dev/null @@ -1,51 +0,0 @@ -# M0110(A) keyboard converter - -This is a port of the original M0110 converter from TMK to QMK. The original converter was designed to work with **ATmega32U2** and **ATmega32U4** based microcontrollers to convert Apple M0110/M0110A keyboards and M0120 numpads to USB. This port has been tested to be compatible with the [**Adafruit Feather 32U4 BLE**](https://learn.adafruit.com/adafruit-feather-32u4-bluefruit-le). - - -## Enabling Bluetooth for the Adafruit Feather 32U4 BLE - -Simply add `BLUETOOTH = AdafruitBLE` to your `rules.mk` file. This enables code specifically for the Adafruit Feather 32U4 BLE. If enabled, the device will use the `PRODUCT` and `DESCRIPTION` values from `config.h` for the device name displayed by the Feather on host devices. You can simply change these values to change the device name. - - -## Pins - -This port utilizes the same pins that the TMK converter used. `PD1` is used for `CLOCK` and `PD0` is used for the `DATA` from the keyboard. These pins can be changed in `config.h`. - - -## Other important hardware notes from the original TMK converter Readme: ->### Hardware ->-------- ->You can buy preassembled [TMK converter] or make yourown with AVR dev board like PJRC [Teensy]. -> ->Port of the MCU `PD1` is assigned to `CLOCK` line and `PD0` to `DATA` by default, you can change pin configuration with editing `config.h`. -> ->[![M0110 Converter](http://i.imgur.com/yEp2eRim.jpg)](http://i.imgur.com/yEp2eRi.jpg) -> ->#### 4P4C phone handset cable ->Note that original cable used with Mac is **straight** while phone handset cable is **crossover**. -> -> -> ->[Teensy]: http://www.pjrc.com/teensy/ ->[TMK converter]: https://geekhack.org/index.php?topic=72052.0 -> -> ->#### Socket Pinout ->- -> ->![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png) -> -> ->#### Pull-up Resistor ->You may need pull-up resistors on signal lines(`CLOCK`, `DATA`) in particular when you have long or coiled cable. **1k-10k Ohm** will be OK >for this purpose. In that case the converter may not read signal from keyboard correctly without pull-up resistors. -> - -[**View the original TMK converter Readme**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb)\ -[**View the original TMK converter Repository**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb) - - -## QMK Port Changelog - -- 2018/08/01 - Original Release - diff --git a/keyboards/converter/m0110_usb/readme.md b/keyboards/converter/m0110_usb/readme.md new file mode 100644 index 0000000000..2e8a2eaef1 --- /dev/null +++ b/keyboards/converter/m0110_usb/readme.md @@ -0,0 +1,51 @@ +# M0110(A) keyboard converter + +This is a port of the original M0110 converter from TMK to QMK. The original converter was designed to work with **ATmega32U2** and **ATmega32U4** based microcontrollers to convert Apple M0110/M0110A keyboards and M0120 numpads to USB. This port has been tested to be compatible with the [**Adafruit Feather 32U4 BLE**](https://learn.adafruit.com/adafruit-feather-32u4-bluefruit-le). + + +## Enabling Bluetooth for the Adafruit Feather 32U4 BLE + +Simply add `BLUETOOTH = AdafruitBLE` to your `rules.mk` file. This enables code specifically for the Adafruit Feather 32U4 BLE. If enabled, the device will use the `PRODUCT` and `DESCRIPTION` values from `config.h` for the device name displayed by the Feather on host devices. You can simply change these values to change the device name. + + +## Pins + +This port utilizes the same pins that the TMK converter used. `PD1` is used for `CLOCK` and `PD0` is used for the `DATA` from the keyboard. These pins can be changed in `config.h`. + + +## Other important hardware notes from the original TMK converter Readme: +>### Hardware +>-------- +>You can buy preassembled [TMK converter] or make yourown with AVR dev board like PJRC [Teensy]. +> +>Port of the MCU `PD1` is assigned to `CLOCK` line and `PD0` to `DATA` by default, you can change pin configuration with editing `config.h`. +> +>[![M0110 Converter](http://i.imgur.com/yEp2eRim.jpg)](http://i.imgur.com/yEp2eRi.jpg) +> +>#### 4P4C phone handset cable +>Note that original cable used with Mac is **straight** while phone handset cable is **crossover**. +> +> +> +>[Teensy]: http://www.pjrc.com/teensy/ +>[TMK converter]: https://geekhack.org/index.php?topic=72052.0 +> +> +>#### Socket Pinout +>- +> +>![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png) +> +> +>#### Pull-up Resistor +>You may need pull-up resistors on signal lines(`CLOCK`, `DATA`) in particular when you have long or coiled cable. **1k-10k Ohm** will be OK >for this purpose. In that case the converter may not read signal from keyboard correctly without pull-up resistors. +> + +[**View the original TMK converter Readme**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb)\ +[**View the original TMK converter Repository**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb) + + +## QMK Port Changelog + +- 2018/08/01 - Original Release + diff --git a/keyboards/converter/usb_usb/README.md b/keyboards/converter/usb_usb/README.md deleted file mode 100644 index 594a9be877..0000000000 --- a/keyboards/converter/usb_usb/README.md +++ /dev/null @@ -1,69 +0,0 @@ -USB to USB keyboard protocol converter -====================================== -A small device to connect between your USB keyboard and your PC that makes (almost) every keyboard fully programmable. -Original code from the [TMK firmware](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb). Ported to QMK by [Balz Guenat](https://github.com/BalzGuenat). - -Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat) -Hardware Supported: [Hasu's USB-USB converter](https://geekhack.org/index.php?topic=69169.0), [Pro Micro + USB Host Shield](https://geekhack.org/index.php?topic=80421.0), maybe more -Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built - -Make example for this keyboard (after setting up your build environment): - - make converter/usb_usb:default - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. - -Note that you have to choose the right hardware variant as your subproject, otherwise you will probably have issues. - -Troubleshooting & Known Issues ------------------------------- -If something doesn't work, it's probably because of the CPU clock. -Be sure to select the correct subproject (the middle part of the `make` argument) according to your hardware. -If you are sure you have this correct, try changeing the default in `usb_usb/rules.mk` or overriding the value in the `rules.mk` of your keymap. - -The Pro Micro variant uses a 3.3V Pro Micro and thus runs at 8MHz, hence the following line in `usb_usb/pro_micro/rules.mk`: -`F_CPU = 8000000` -The converter sold by Hasu runs at 16MHz and so the corresponding line in `usb_usb/hasu/rules.mk` is: -`F_CPU = 16000000` - -Getting the Hardware --------------------- -There are two options to get a converter: You can buy one from Hasu or build one yourself. - -### Buy a Converter -You can buy a fully assembled converter from me here: -https://geekhack.org/index.php?topic=69169.0 - -### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0 -Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron. -- http://arduino.cc/en/Main/ArduinoBoardLeonardo -- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ - -Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified. -- http://arduino.cc/en/Main/ArduinoUSBHostShield -- https://www.sparkfun.com/products/9947 - -Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing. -- [Build guide](https://geekhack.org/index.php?topic=80421.0) -- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ -- https://www.sparkfun.com/products/12587 -- https://www.pjrc.com/teensy/td_libs_USBHostShield.html - -Limitations ----------- -Only supports 'HID Boot protocol'. -Note that the converter can host only USB "boot protocol" keyboard(6KRO), not NKRO, it is possible to support NKRO keyboard but you will need to write HID report parser for that. Every NKRO keyboard can have different HID report and it is difficult to support all kind of NKRO keyboards in the market. - -Resources --------- -- [Hasu's main thread for the converter](https://geekhack.org/index.php?topic=69169.0) -- [Build guide for the Pro Micro variant](https://geekhack.org/index.php?topic=80421.0) -- [Original TMK version of the converter](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb) -- [USB Host Shield 2.0](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) -- [USB Host Shield 2.0 source](https://github.com/felis/USB_Host_Shield_2.0) -- [Arduino USB Host Shield (with bootst converter)](http://arduino.cc/en/Main/ArduinoUSBHostShield) -- [Arduino source](https://github.com/arduino/Arduino) -- [Initial release of TMK USB-USB converter](https://geekhack.org/index.php?topic=33057.msg653549#msg653549) -- [Teensy/Arduino + Host Shield](http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854) -- [Arduino-based hardware keyboard remapper - Colemak forum](http://forum.colemak.com/viewtopic.php?id=1561) -- [Teensy + Host Shield](http://www.pjrc.com/teensy/td_libs_USBHostShield.html) diff --git a/keyboards/converter/usb_usb/ble/README.md b/keyboards/converter/usb_usb/ble/README.md deleted file mode 100644 index 0ee7223fd4..0000000000 --- a/keyboards/converter/usb_usb/ble/README.md +++ /dev/null @@ -1,30 +0,0 @@ -QMK BLE Adapter -=============== -A small device that reads USB keyboard input and passes it on over Bluetooth LE HID. - -![Picture of Adapter](https://i.imgur.com/O3VwBBJ.png) - -Hardware --------- -The hardware is relatively easy to assemble. Just follow the schematic and don't forget to [cut the VBUS jumper](https://www.pjrc.com/teensy/td_libs_USBHostShield_4a.jpg). - -Schematic: -![Schematic](https://i.imgur.com/s1Ia9We.png) - -Part list: -* [Adafruit Feather 32u4 Bluefruit LE](https://www.adafruit.com/product/2829) -* [USB Host Mini](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) -* [Pololu 5V Step-Up Voltage Regulator U3V12F5](https://www.pololu.com/product/2115) -* [Lithium Ion Battery - 3.7v 2000mAh](https://www.adafruit.com/product/2011) -* Some sort of switch to be able to turn it off - -Building and Flashing ---------------------- - -``` -make converter-usb_usb-ble -``` - -``` -make converter-usb_usb-ble-avrdude -``` \ No newline at end of file diff --git a/keyboards/converter/usb_usb/ble/readme.md b/keyboards/converter/usb_usb/ble/readme.md new file mode 100644 index 0000000000..0ee7223fd4 --- /dev/null +++ b/keyboards/converter/usb_usb/ble/readme.md @@ -0,0 +1,30 @@ +QMK BLE Adapter +=============== +A small device that reads USB keyboard input and passes it on over Bluetooth LE HID. + +![Picture of Adapter](https://i.imgur.com/O3VwBBJ.png) + +Hardware +-------- +The hardware is relatively easy to assemble. Just follow the schematic and don't forget to [cut the VBUS jumper](https://www.pjrc.com/teensy/td_libs_USBHostShield_4a.jpg). + +Schematic: +![Schematic](https://i.imgur.com/s1Ia9We.png) + +Part list: +* [Adafruit Feather 32u4 Bluefruit LE](https://www.adafruit.com/product/2829) +* [USB Host Mini](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) +* [Pololu 5V Step-Up Voltage Regulator U3V12F5](https://www.pololu.com/product/2115) +* [Lithium Ion Battery - 3.7v 2000mAh](https://www.adafruit.com/product/2011) +* Some sort of switch to be able to turn it off + +Building and Flashing +--------------------- + +``` +make converter-usb_usb-ble +``` + +``` +make converter-usb_usb-ble-avrdude +``` \ No newline at end of file diff --git a/keyboards/converter/usb_usb/readme.md b/keyboards/converter/usb_usb/readme.md new file mode 100644 index 0000000000..594a9be877 --- /dev/null +++ b/keyboards/converter/usb_usb/readme.md @@ -0,0 +1,69 @@ +USB to USB keyboard protocol converter +====================================== +A small device to connect between your USB keyboard and your PC that makes (almost) every keyboard fully programmable. +Original code from the [TMK firmware](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb). Ported to QMK by [Balz Guenat](https://github.com/BalzGuenat). + +Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat) +Hardware Supported: [Hasu's USB-USB converter](https://geekhack.org/index.php?topic=69169.0), [Pro Micro + USB Host Shield](https://geekhack.org/index.php?topic=80421.0), maybe more +Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built + +Make example for this keyboard (after setting up your build environment): + + make converter/usb_usb:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. + +Note that you have to choose the right hardware variant as your subproject, otherwise you will probably have issues. + +Troubleshooting & Known Issues +------------------------------ +If something doesn't work, it's probably because of the CPU clock. +Be sure to select the correct subproject (the middle part of the `make` argument) according to your hardware. +If you are sure you have this correct, try changeing the default in `usb_usb/rules.mk` or overriding the value in the `rules.mk` of your keymap. + +The Pro Micro variant uses a 3.3V Pro Micro and thus runs at 8MHz, hence the following line in `usb_usb/pro_micro/rules.mk`: +`F_CPU = 8000000` +The converter sold by Hasu runs at 16MHz and so the corresponding line in `usb_usb/hasu/rules.mk` is: +`F_CPU = 16000000` + +Getting the Hardware +-------------------- +There are two options to get a converter: You can buy one from Hasu or build one yourself. + +### Buy a Converter +You can buy a fully assembled converter from me here: +https://geekhack.org/index.php?topic=69169.0 + +### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0 +Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron. +- http://arduino.cc/en/Main/ArduinoBoardLeonardo +- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ + +Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified. +- http://arduino.cc/en/Main/ArduinoUSBHostShield +- https://www.sparkfun.com/products/9947 + +Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing. +- [Build guide](https://geekhack.org/index.php?topic=80421.0) +- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ +- https://www.sparkfun.com/products/12587 +- https://www.pjrc.com/teensy/td_libs_USBHostShield.html + +Limitations +---------- +Only supports 'HID Boot protocol'. +Note that the converter can host only USB "boot protocol" keyboard(6KRO), not NKRO, it is possible to support NKRO keyboard but you will need to write HID report parser for that. Every NKRO keyboard can have different HID report and it is difficult to support all kind of NKRO keyboards in the market. + +Resources +-------- +- [Hasu's main thread for the converter](https://geekhack.org/index.php?topic=69169.0) +- [Build guide for the Pro Micro variant](https://geekhack.org/index.php?topic=80421.0) +- [Original TMK version of the converter](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb) +- [USB Host Shield 2.0](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) +- [USB Host Shield 2.0 source](https://github.com/felis/USB_Host_Shield_2.0) +- [Arduino USB Host Shield (with bootst converter)](http://arduino.cc/en/Main/ArduinoUSBHostShield) +- [Arduino source](https://github.com/arduino/Arduino) +- [Initial release of TMK USB-USB converter](https://geekhack.org/index.php?topic=33057.msg653549#msg653549) +- [Teensy/Arduino + Host Shield](http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854) +- [Arduino-based hardware keyboard remapper - Colemak forum](http://forum.colemak.com/viewtopic.php?id=1561) +- [Teensy + Host Shield](http://www.pjrc.com/teensy/td_libs_USBHostShield.html) diff --git a/keyboards/converter/xt_usb/README.md b/keyboards/converter/xt_usb/README.md deleted file mode 100644 index 40b265a189..0000000000 --- a/keyboards/converter/xt_usb/README.md +++ /dev/null @@ -1,17 +0,0 @@ -XT to USB keyboard converter -============================== -This is a port of TMK's converter/xt_usb to QMK. - -This firmware converts XT keyboard protocol to USB.(It supports Scan Code Set 1.) - - -Connect Wires -------------- -1. Connect **Vcc** and **GND**. -2. Connect **Clock** and **Data** line. **Clock** is on `PD1`, **Data** on `PD0` by default. And optionally you can use `PB7` for **Reset**.(Compatible to Soarer's converter) To change pin configuration edit `config.h`. -3. You need pull-up resistor. **1K-10K Ohm** will be OK. - - -XT keyboard protocol resource ------------------------------- -https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol diff --git a/keyboards/converter/xt_usb/readme.md b/keyboards/converter/xt_usb/readme.md new file mode 100644 index 0000000000..40b265a189 --- /dev/null +++ b/keyboards/converter/xt_usb/readme.md @@ -0,0 +1,17 @@ +XT to USB keyboard converter +============================== +This is a port of TMK's converter/xt_usb to QMK. + +This firmware converts XT keyboard protocol to USB.(It supports Scan Code Set 1.) + + +Connect Wires +------------- +1. Connect **Vcc** and **GND**. +2. Connect **Clock** and **Data** line. **Clock** is on `PD1`, **Data** on `PD0` by default. And optionally you can use `PB7` for **Reset**.(Compatible to Soarer's converter) To change pin configuration edit `config.h`. +3. You need pull-up resistor. **1K-10K Ohm** will be OK. + + +XT keyboard protocol resource +------------------------------ +https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol diff --git a/keyboards/db/db63/README.md b/keyboards/db/db63/README.md deleted file mode 100644 index e886bed0a1..0000000000 --- a/keyboards/db/db63/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# DB63 - -A 65% keyboard hotswap with RGB that runs ps2avrgb natively, with USB C, RGB underglow and backlight. - -* Keyboard Maintainer: QMK Community -* Hardware Supported: DB63 (ATmega32A) -* [Keyboard layout](http://www.keyboard-layout-editor.com/#/gists/dadea703fc8bfc87dc7c480de9f3ef38) - -Make example for this keyboard (after setting up your build environment): - - make db/db63:default - -Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) - - make db/db63:default:flash - -**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Escape* while plugging in the keyboard. (*All backlight LEDs will flash which indicate the board is in bootloader mode.*) - -**Tips**: Another trick to enable the board in reset mode is using BootMapper Client->Options->Set Bootloader. (*This is only available for the first time, before flashing QMK Firmware.*) - -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). diff --git a/keyboards/db/db63/readme.md b/keyboards/db/db63/readme.md new file mode 100644 index 0000000000..e886bed0a1 --- /dev/null +++ b/keyboards/db/db63/readme.md @@ -0,0 +1,21 @@ +# DB63 + +A 65% keyboard hotswap with RGB that runs ps2avrgb natively, with USB C, RGB underglow and backlight. + +* Keyboard Maintainer: QMK Community +* Hardware Supported: DB63 (ATmega32A) +* [Keyboard layout](http://www.keyboard-layout-editor.com/#/gists/dadea703fc8bfc87dc7c480de9f3ef38) + +Make example for this keyboard (after setting up your build environment): + + make db/db63:default + +Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) + + make db/db63:default:flash + +**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Escape* while plugging in the keyboard. (*All backlight LEDs will flash which indicate the board is in bootloader mode.*) + +**Tips**: Another trick to enable the board in reset mode is using BootMapper Client->Options->Set Bootloader. (*This is only available for the first time, before flashing QMK Firmware.*) + +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). diff --git a/keyboards/fc660c/README.md b/keyboards/fc660c/README.md deleted file mode 100644 index 638c559577..0000000000 --- a/keyboards/fc660c/README.md +++ /dev/null @@ -1,167 +0,0 @@ -FC660C Alt Controller -================= - -This file and the entire QMK port of this board are based on its TMK implementation: https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc980c - ------------- - -- Ke