From 561e535a583c437b96f1f4dd9d3325d42a8a9156 Mon Sep 17 00:00:00 2001 From: innovaker <66737976+innovaker@users.noreply.github.com> Date: Fri, 1 Jan 2021 15:17:19 +0000 Subject: refactor(shields): standardize README.md filenames Renames instances of `readme.md` to `README.md` so that it's easily noticed. PR: #561 --- app/boards/shields/bfo9000/README.md | 13 ++++++++++++ app/boards/shields/bfo9000/readme.md | 13 ------------ app/boards/shields/clueboard_california/README.md | 24 +++++++++++++++++++++++ app/boards/shields/clueboard_california/readme.md | 24 ----------------------- app/boards/shields/crbn/README.md | 1 + app/boards/shields/crbn/readme.md | 1 - app/boards/shields/eek/README.md | 1 + app/boards/shields/eek/readme.md | 1 - app/boards/shields/m60/README.md | 14 +++++++++++++ app/boards/shields/m60/readme.md | 14 ------------- 10 files changed, 53 insertions(+), 53 deletions(-) create mode 100644 app/boards/shields/bfo9000/README.md delete mode 100644 app/boards/shields/bfo9000/readme.md create mode 100644 app/boards/shields/clueboard_california/README.md delete mode 100644 app/boards/shields/clueboard_california/readme.md create mode 100644 app/boards/shields/crbn/README.md delete mode 100644 app/boards/shields/crbn/readme.md create mode 100644 app/boards/shields/eek/README.md delete mode 100644 app/boards/shields/eek/readme.md create mode 100644 app/boards/shields/m60/README.md delete mode 100644 app/boards/shields/m60/readme.md (limited to 'app/boards') diff --git a/app/boards/shields/bfo9000/README.md b/app/boards/shields/bfo9000/README.md new file mode 100644 index 0000000..1e91fdc --- /dev/null +++ b/app/boards/shields/bfo9000/README.md @@ -0,0 +1,13 @@ +# [BFO-9000](https://keeb.io/products/bfo-9000-keyboard-customizable-full-size-split-ortholinear) + +Customizable full-size split ortholinear. + +## Features + +* Compatible with MX-compatible, Alps-compatible, and Kailh Low-Profile Choc switches. +* Breakoff pieces to allow for 4 to 6 rows and 7 to 9 columns. +* RGB LED connections + +## Hardware Notes + +[Included default keymap](http://www.keyboard-layout-editor.com/#/gists/51293c31afcd5f1765e8f413a46bfcf8) \ No newline at end of file diff --git a/app/boards/shields/bfo9000/readme.md b/app/boards/shields/bfo9000/readme.md deleted file mode 100644 index 1e91fdc..0000000 --- a/app/boards/shields/bfo9000/readme.md +++ /dev/null @@ -1,13 +0,0 @@ -# [BFO-9000](https://keeb.io/products/bfo-9000-keyboard-customizable-full-size-split-ortholinear) - -Customizable full-size split ortholinear. - -## Features - -* Compatible with MX-compatible, Alps-compatible, and Kailh Low-Profile Choc switches. -* Breakoff pieces to allow for 4 to 6 rows and 7 to 9 columns. -* RGB LED connections - -## Hardware Notes - -[Included default keymap](http://www.keyboard-layout-editor.com/#/gists/51293c31afcd5f1765e8f413a46bfcf8) \ No newline at end of file diff --git a/app/boards/shields/clueboard_california/README.md b/app/boards/shields/clueboard_california/README.md new file mode 100644 index 0000000..0255eff --- /dev/null +++ b/app/boards/shields/clueboard_california/README.md @@ -0,0 +1,24 @@ +# [Clueboard California Macropad](https://clueboard.co/parts/clueboard-california-macropad-kit) + +A small 10-key macropad in the shape of the US state of California. + +## Features + +- Per key LED. +- Proton-C only, including space for the piezo speaker. +- Direct GPIO wiring, no GPIO matrix at all. + +## Hardware Notes + +| Switch | Switch Pin | LED Pin | +| ------------ | ---------- | ------- | +| shasta1 | a10 | a2 | +| modoc1 | a9 | b5 | +| mendocino1 | a0 | a1 | +| lassen1 | b8 | b4 | +| eldorado1 | b11 | b12 | +| big_sur1 | b9 | b10 | +| sierra1 | a8 | a15 | +| los_padres1 | a7 | a6 | +| mojave1 | b1 | b0 | +| joshua_tree1 | b2 | b3 | diff --git a/app/boards/shields/clueboard_california/readme.md b/app/boards/shields/clueboard_california/readme.md deleted file mode 100644 index 0255eff..0000000 --- a/app/boards/shields/clueboard_california/readme.md +++ /dev/null @@ -1,24 +0,0 @@ -# [Clueboard California Macropad](https://clueboard.co/parts/clueboard-california-macropad-kit) - -A small 10-key macropad in the shape of the US state of California. - -## Features - -- Per key LED. -- Proton-C only, including space for the piezo speaker. -- Direct GPIO wiring, no GPIO matrix at all. - -## Hardware Notes - -| Switch | Switch Pin | LED Pin | -| ------------ | ---------- | ------- | -| shasta1 | a10 | a2 | -| modoc1 | a9 | b5 | -| mendocino1 | a0 | a1 | -| lassen1 | b8 | b4 | -| eldorado1 | b11 | b12 | -| big_sur1 | b9 | b10 | -| sierra1 | a8 | a15 | -| los_padres1 | a7 | a6 | -| mojave1 | b1 | b0 | -| joshua_tree1 | b2 | b3 | diff --git a/app/boards/shields/crbn/README.md b/app/boards/shields/crbn/README.md new file mode 100644 index 0000000..fee388f --- /dev/null +++ b/app/boards/shields/crbn/README.md @@ -0,0 +1 @@ +A 40% Ortho keyboard made by Polarity Works diff --git a/app/boards/shields/crbn/readme.md b/app/boards/shields/crbn/readme.md deleted file mode 100644 index fee388f..0000000 --- a/app/boards/shields/crbn/readme.md +++ /dev/null @@ -1 +0,0 @@ -A 40% Ortho keyboard made by Polarity Works diff --git a/app/boards/shields/eek/README.md b/app/boards/shields/eek/README.md new file mode 100644 index 0000000..2a1b46b --- /dev/null +++ b/app/boards/shields/eek/README.md @@ -0,0 +1 @@ +A fixed split 36key-board with a typing angle of 90 degrees distributed by cbkbd diff --git a/app/boards/shields/eek/readme.md b/app/boards/shields/eek/readme.md deleted file mode 100644 index 2a1b46b..0000000 --- a/app/boards/shields/eek/readme.md +++ /dev/null @@ -1 +0,0 @@ -A fixed split 36key-board with a typing angle of 90 degrees distributed by cbkbd diff --git a/app/boards/shields/m60/README.md b/app/boards/shields/m60/README.md new file mode 100644 index 0000000..e801c78 --- /dev/null +++ b/app/boards/shields/m60/README.md @@ -0,0 +1,14 @@ +# [Makerdiary M60](https://wiki.makerdiary.com/m60) + +A 60% ANSI keyboard designed and manufactured by Makerdiary. +http://makerdiary.com + +## Features + +- Per key RGB LED. +- Uses makerdiary M.2 nRF52840 module +- Matrix wiring + +## Hardware Notes + +https://wiki.makerdiary.com/m60/developer_guide/hardware/ diff --git a/app/boards/shields/m60/readme.md b/app/boards/shields/m60/readme.md deleted file mode 100644 index e801c78..0000000 --- a/app/boards/shields/m60/readme.md +++ /dev/null @@ -1,14 +0,0 @@ -# [Makerdiary M60](https://wiki.makerdiary.com/m60) - -A 60% ANSI keyboard designed and manufactured by Makerdiary. -http://makerdiary.com - -## Features - -- Per key RGB LED. -- Uses makerdiary M.2 nRF52840 module -- Matrix wiring - -## Hardware Notes - -https://wiki.makerdiary.com/m60/developer_guide/hardware/ -- cgit v1.2.3