From e4823aadec24bca0ecfd1184562d27a49fd20544 Mon Sep 17 00:00:00 2001 From: Ryan Date: Tue, 26 May 2020 12:43:14 +1000 Subject: [PATCH] Fix capitalisation of "GitHub" (#9184) --- docs/breaking_changes.md | 2 +- docs/cli_configuration.md | 2 +- docs/cli_development.md | 2 +- docs/configurator_step_by_step.md | 2 +- docs/de/README.md | 2 +- docs/de/_summary.md | 2 +- docs/de/newbs_learn_more_resources.md | 2 +- docs/es/README.md | 2 +- docs/es/_summary.md | 2 +- docs/es/newbs_best_practices.md | 2 +- docs/es/newbs_building_firmware_configurator.md | 2 +- docs/es/newbs_learn_more_resources.md | 2 +- docs/feature_userspace.md | 6 +++--- docs/fr-fr/README.md | 6 +++--- docs/fr-fr/breaking_changes.md | 2 +- docs/fr-fr/getting_started_github.md | 4 ++-- docs/fr-fr/newbs_best_practices.md | 2 +- docs/getting_started_github.md | 12 ++++++------ docs/he-il/README.md | 2 +- docs/he-il/_summary.md | 4 ++-- docs/he-il/getting_started_getting_help.md | 2 +- docs/he-il/getting_started_github.md | 10 +++++----- docs/ja/cli_configuration.md | 2 +- docs/ja/getting_started_github.md | 8 ++++---- docs/ja/newbs_building_firmware_configurator.md | 2 +- docs/ja/newbs_learn_more_resources.md | 4 ++-- docs/newbs_getting_started.md | 2 +- docs/other_vscode.md | 2 +- docs/pt-br/README.md | 2 +- docs/pt-br/_summary.md | 2 +- docs/ru-ru/_summary.md | 2 +- docs/ru-ru/getting_started_github.md | 4 ++-- docs/support.md | 2 +- docs/zh-cn/README.md | 2 +- docs/zh-cn/_summary.md | 2 +- docs/zh-cn/getting_started_getting_help.md | 2 +- docs/zh-cn/getting_started_github.md | 12 ++++++------ docs/zh-cn/newbs_building_firmware.md | 2 +- drivers/avr/apa102.c | 2 +- drivers/avr/i2c_master.c | 2 +- drivers/avr/i2c_master.h | 2 +- drivers/avr/i2c_slave.c | 2 +- drivers/avr/i2c_slave.h | 2 +- keyboards/8pack/readme.md | 2 +- keyboards/abacus/readme.md | 2 +- keyboards/allison/readme.md | 2 +- keyboards/allison_numpad/readme.md | 2 +- keyboards/alps64/readme.md | 2 +- keyboards/baguette/readme.md | 2 +- keyboards/converter/siemens_tastatur/readme.md | 2 +- keyboards/gingham/readme.md | 2 +- keyboards/handwired/fruity60/readme.md | 2 +- keyboards/handwired/mechboards_micropad/readme.md | 2 +- keyboards/hs60/v1/readme.md | 2 +- keyboards/hs60/v2/readme.md | 2 +- keyboards/keycapsss/o4l_5x12/readme.md | 2 +- keyboards/keycapsss/plaid_pad/readme.md | 2 +- keyboards/kv/revt/readme.md | 2 +- keyboards/maartenwut/mx5160/readme.md | 2 +- keyboards/mc_76k/readme.md | 2 +- keyboards/meson/readme.md | 2 +- keyboards/nightmare/readme.md | 2 +- keyboards/nk65/readme.md | 2 +- keyboards/pimentoso/paddino02/readme.md | 2 +- keyboards/tg4x/readme.md | 2 +- keyboards/uranuma/readme.md | 2 +- keyboards/vinta/readme.md | 2 +- keyboards/wilba_tech/zeal60/readme.md | 2 +- keyboards/wilba_tech/zeal65/readme.md | 2 +- tmk_core/protocol/arm_atsam/led_matrix.c | 2 +- 70 files changed, 95 insertions(+), 95 deletions(-) diff --git a/docs/breaking_changes.md b/docs/breaking_changes.md index 12bc0db9da..6c684970d8 100644 --- a/docs/breaking_changes.md +++ b/docs/breaking_changes.md @@ -102,7 +102,7 @@ This happens immediately after the previous `future` branch is merged. * [ ] Roll up the ChangeLog into one file. * [ ] `git commit -m 'Merge point for Breaking Change'` * [ ] `git push origin future` -* Github Actions +* GitHub Actions * [ ] Create a PR for `future` * [ ] Make sure travis comes back clean * [ ] Merge `future` PR diff --git a/docs/cli_configuration.md b/docs/cli_configuration.md index 1196ab669d..50f5dc6e28 100644 --- a/docs/cli_configuration.md +++ b/docs/cli_configuration.md @@ -108,7 +108,7 @@ compile.keymap: skully -> None |-----|---------------|-------------| | user.keyboard | None | The keyboard path (Example: `clueboard/66/rev4`) | | user.keymap | None | The keymap name (Example: `default`) | -| user.name | None | The user's github username. | +| user.name | None | The user's GitHub username. | # All Configuration Options diff --git a/docs/cli_development.md b/docs/cli_development.md index af86686c07..07c8f281ba 100644 --- a/docs/cli_development.md +++ b/docs/cli_development.md @@ -210,7 +210,7 @@ Our tests can be found in `lib/python/qmk/tests/`. You will find both unit and i If your PR does not include a comprehensive set of tests please add comments like this to your code so that other people know where they can help: - # TODO(unassigned/): Write tests + # TODO(unassigned/): Write tests We use [nose2](https://nose2.readthedocs.io/en/latest/getting_started.html) to run our tests. You can refer to the nose2 documentation for more details on what you can do in your test functions. diff --git a/docs/configurator_step_by_step.md b/docs/configurator_step_by_step.md index aee1d4e1f6..965012a907 100644 --- a/docs/configurator_step_by_step.md +++ b/docs/configurator_step_by_step.md @@ -12,7 +12,7 @@ I'll say that again because it's important: !> **MAKE SURE YOU SELECT THE RIGHT VERSION!** -If your keyboard has been advertised to be powered by QMK but is not in the list, chances are a developer hasn't gotten to it yet or we haven't had a chance to merge it in yet. File an issue at [qmk_firmware](https://github.com/qmk/qmk_firmware/issues) requesting to support that particular keyboard, if there is no active [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) for it. There are also QMK powered keyboards that are in their manufacturer's own github accounts. Double check for that as well. +If your keyboard has been advertised to be powered by QMK but is not in the list, chances are a developer hasn't gotten to it yet or we haven't had a chance to merge it in yet. File an issue at [qmk_firmware](https://github.com/qmk/qmk_firmware/issues) requesting to support that particular keyboard, if there is no active [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) for it. There are also QMK powered keyboards that are in their manufacturer's own GitHub accounts. Double check for that as well. ## Step 2: Select Your Keyboard Layout diff --git a/docs/de/README.md b/docs/de/README.md index 88239d45d4..bf8fbac57a 100644 --- a/docs/de/README.md +++ b/docs/de/README.md @@ -13,7 +13,7 @@ QMK (*Quantum Mechanical Keyboard*) ist eine Open-Source-Community, welche die Q ## Bezugsquelle für QMK -Wenn Du vorhast, deine Tastatur, Tastaturbelegung oder Features zu QMK beizusteuern, geht das am einfachsten, indem Du das [Repository auf Github](https://github.com/qmk/qmk_firmware#fork-destination-box) forkst, die Änderungen in deinem lokalen Repo vornimmst und anschließend einen [Pull Request](https://github.com/qmk/qmk_firmware/pulls) einreichst. +Wenn Du vorhast, deine Tastatur, Tastaturbelegung oder Features zu QMK beizusteuern, geht das am einfachsten, indem Du das [Repository auf GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box) forkst, die Änderungen in deinem lokalen Repo vornimmst und anschließend einen [Pull Request](https://github.com/qmk/qmk_firmware/pulls) einreichst. Ansonsten kannst Du es als [zip](https://github.com/qmk/qmk_firmware/zipball/master) oder [tar](https://github.com/qmk/qmk_firmware/tarball/master) herunterladen, oder es direkt via git klonen (`git clone git@github.com:qmk/qmk_firmware.git` bzw. `git clone https://github.com/qmk/qmk_firmware.git`). diff --git a/docs/de/_summary.md b/docs/de/_summary.md index 19c75ecd38..ffbd292bd4 100644 --- a/docs/de/_summary.md +++ b/docs/de/_summary.md @@ -11,7 +11,7 @@ * [QMK CLI](de/cli.md) * [QMK CLI Konfiguration](de/cli_configuration.md) * [Zu QMK beitragen](de/contributing.md) - * [Anleitung für Github](de/getting_started_github.md) + * [Anleitung für GitHub](de/getting_started_github.md) * [Nach Hilfe fragen](de/getting_started_getting_help.md) * [Breaking Changes](de/breaking_changes.md) diff --git a/docs/de/newbs_learn_more_resources.md b/docs/de/newbs_learn_more_resources.md index 59b72152dd..ac5adb0c12 100644 --- a/docs/de/newbs_learn_more_resources.md +++ b/docs/de/newbs_learn_more_resources.md @@ -6,7 +6,7 @@ Git Ressourcen: * [Gutes allgemeines Tutorial](https://www.codecademy.com/learn/learn-git) (auf Englisch) * [Git spielerisch anhand von Beispielen lernen](https://learngitbranching.js.org/) (auf Englisch) -* [Mehr über den allgemeinen Umgang mit Github](getting_started_github.md) +* [Mehr über den allgemeinen Umgang mit GitHub](getting_started_github.md) * [Mehr über Git im Bezug zu QMK](contributing.md) Mehr über die Arbeit mit der Befehlszeile: diff --git a/docs/es/README.md b/docs/es/README.md index d39b278008..75fd3cb64e 100644 --- a/docs/es/README.md +++ b/docs/es/README.md @@ -13,7 +13,7 @@ QMK (*Quantum Mechanical Keyboard*) es una comunidad open source que mantiene el ## Cómo conseguirlo -Si estás pensando en contribuir con un keymap, teclado, or característica a QMK, la manera más sencilla es hacer un [fork del repositorio en Github](https://github.com/qmk/qmk_firmware#fork-destination-box), y clonar tu repositorio localmente para hacer los cambios, subirlos, y abir un [Pull Request](https://github.com/qmk/qmk_firmware/pulls) desde tu fork. +Si estás pensando en contribuir con un keymap, teclado, or característica a QMK, la manera más sencilla es hacer un [fork del repositorio en GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), y clonar tu repositorio localmente para hacer los cambios, subirlos, y abir un [Pull Request](https://github.com/qmk/qmk_firmware/pulls) desde tu fork. De cualquier manera, también puedes descargarlo directamente en formatos ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), o clonarlo via git (`git@github.com:qmk/qmk_firmware.git`), o https (`https://github.com/qmk/qmk_firmware.git`). diff --git a/docs/es/_summary.md b/docs/es/_summary.md index b58d825f74..aa2a0ca5d9 100644 --- a/docs/es/_summary.md +++ b/docs/es/_summary.md @@ -11,7 +11,7 @@ * [QMK CLI](es/cli.md) * [Configuración de QMK CLI](es/cli_configuration.md) * [Contribuyendo a QMK](es/contributing.md) - * [Cómo usar Github](es/getting_started_github.md) + * [Cómo usar GitHub](es/getting_started_github.md) * [Obtener ayuda](es/getting_started_getting_help.md) * [Cambios incompatibles](es/breaking_changes.md) diff --git a/docs/es/newbs_best_practices.md b/docs/es/newbs_best_practices.md index fc2afb9ed2..2f72eff788 100644 --- a/docs/es/newbs_best_practices.md +++ b/docs/es/newbs_best_practices.md @@ -6,7 +6,7 @@ Este documento procura instruir a los novatos en las mejores prácticas para ten En este documento suponemos un par de cosas: -1. Tienes una cuenta de Github, y has hecho un [fork del repo qmk_firmware](getting_started_github.md) en tu cuenta. +1. Tienes una cuenta de GitHub, y has hecho un [fork del repo qmk_firmware](getting_started_github.md) en tu cuenta. 2. Has [configurado tu entorno de desarrollo](newbs_getting_started.md?id=environment-setup). diff --git a/docs/es/newbs_building_firmware_configurator.md b/docs/es/newbs_building_firmware_configurator.md index 9333159c2c..60d67f5fa4 100644 --- a/docs/es/newbs_building_firmware_configurator.md +++ b/docs/es/newbs_building_firmware_configurator.md @@ -21,7 +21,7 @@ Lo diré otra vez porque es importante !> **ASEGÚRATE DE QUE SELECCIONAS LA VERSIÓN CORRECTA!** -Si se ha anunciado que tu teclado funciona con QMK pero no está en la lista, es probable que un desarrollador no se haya encargado de él aún o que todavía no hemos tenido la oportunidad de incluirlo. Abre un issue en [qmk_firmware](https://github.com/qmk/qmk_firmware/issues) solicitando soportar ese teclado un particular, si no hay un [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) activo para ello. Hay también teclados que funcionan con QMK que están en las cuentas de github de sus manufacturantes. Acuérdate de comprobar esto también. +Si se ha anunciado que tu teclado funciona con QMK pero no está en la lista, es probable que un desarrollador no se haya encargado de él aún o que todavía no hemos tenido la oportunidad de incluirlo. Abre un issue en [qmk_firmware](https://github.com/qmk/qmk_firmware/issues) solicitando soportar ese teclado un particular, si no hay un [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) activo para ello. Hay también teclados que funcionan con QMK que están en las cuentas de GitHub de sus manufacturantes. Acuérdate de comprobar esto también. ## Eligiendo el layout de tu teclado diff --git a/docs/es/newbs_learn_more_resources.md b/docs/es/newbs_learn_more_resources.md index 413b9ffa5e..34fd7556bf 100644 --- a/docs/es/newbs_learn_more_resources.md +++ b/docs/es/newbs_learn_more_resources.md @@ -6,7 +6,7 @@ Recursos de Git: * [Excelente tutorial general](https://www.codecademy.com/learn/learn-git) * [Juego de Git para aprender usando ejemplos](https://learngitbranching.js.org/) -* [Recursos de Git para aprender más sobre Github](getting_started_github.md) +* [Recursos de Git para aprender más sobre GitHub](getting_started_github.md) * [Recursos de Git dirigidos específicamente a QMK](contributing.md) diff --git a/docs/feature_userspace.md b/docs/feature_userspace.md index ac0a1360d9..8665481db9 100644 --- a/docs/feature_userspace.md +++ b/docs/feature_userspace.md @@ -1,6 +1,6 @@ # Userspace: Sharing Code Between Keymaps -If you use more than one keyboard with a similar keymap, you might see the benefit in being able to share code between them. Create your own folder in `users/` named the same as your keymap (ideally your github username, ``) with the following structure: +If you use more than one keyboard with a similar keymap, you might see the benefit in being able to share code between them. Create your own folder in `users/` named the same as your keymap (ideally your GitHub username, ``) with the following structure: * `/users//` (added to the path automatically) * `readme.md` (optional, recommended) @@ -73,7 +73,7 @@ The reason for this, is that `.h` won't be added in time to add settings ( ## Readme (`readme.md`) -Please include authorship (your name, github username, email), and optionally [a license that's GPL compatible](https://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses). +Please include authorship (your name, GitHub username, email), and optionally [a license that's GPL compatible](https://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses). You can use this as a template: ``` @@ -93,7 +93,7 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . ``` -You'd want to replace the year, name, email and github username with your info. +You'd want to replace the year, name, email and GitHub username with your info. Additionally, this is a good place to document your code, if you wish to share it with others. diff --git a/docs/fr-fr/README.md b/docs/fr-fr/README.md index 4527ec4b42..3743bedc97 100644 --- a/docs/fr-fr/README.md +++ b/docs/fr-fr/README.md @@ -4,8 +4,8 @@ [![Statut du build](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware) [![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh) [![Statut de la doc](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm) -[![Contributeurs Github](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly) -[![Forks Github](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/) +[![Contributeurs GitHub](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly) +[![Forks GitHub](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/) ## Qu'est-ce que QMK Firmware ? @@ -13,7 +13,7 @@ QMK (*Quantum Mechanical Keyboard*) est une communauté open source qui maintien ## Comment l'obtenir -Si vous souhaitez contribuer à une disposition de clavier (keymap), ou à des fonctionnalités de QMK alors le plus simple est de [forker le dépôt avec Github](https://github.com/qmk/qmk_firmware#fork-destination-box) puis cloner le dépôt localement pour y faire des changements. Vous pourrez pousser vos changements sur github puis ouvrir un [Pull Request](https://github.com/qmk/qmk_firmware/pulls) depuis votre fork Github. +Si vous souhaitez contribuer à une disposition de clavier (keymap), ou à des fonctionnalités de QMK alors le plus simple est de [forker le dépôt avec GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box) puis cloner le dépôt localement pour y faire des changements. Vous pourrez pousser vos changements sur GitHub puis ouvrir un [Pull Request](https://github.com/qmk/qmk_firmware/pulls) depuis votre fork GitHub. Sinon, vous pouvez aussi le télécharger directement en ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), ou le cloner avec git en ssh (`git@github.com:qmk/qmk_firmware.git`), ou https (`https://github.com/qmk/qmk_firmware.git`). diff --git a/docs/fr-fr/breaking_changes.md b/docs/fr-fr/breaking_changes.md index 53bbb2212a..2dbb26e5a5 100644 --- a/docs/fr-fr/breaking_changes.md +++ b/docs/fr-fr/breaking_changes.md @@ -101,7 +101,7 @@ Ceci est fait immédiatement après la fusion de la branche `future` précédent * [ ] Regroupe ChangeLog dans un fichier. * [ ] `git commit -m 'Merge point for Breaking Change'` * [ ] `git push origin future` -* Actions sur Github +* Actions sur GitHub * [ ] Crée un PR pour `future` * [ ] S'assurer que Travis ne relève aucun problème * [ ] Fusion le PR `future` diff --git a/docs/fr-fr/getting_started_github.md b/docs/fr-fr/getting_started_github.md index 48755625a7..76d107dfb9 100644 --- a/docs/fr-fr/getting_started_github.md +++ b/docs/fr-fr/getting_started_github.md @@ -6,11 +6,11 @@ GitHub peut être un peu compliqué pour ceux qui n'y sont pas familier. Ce guid Commencez par la [page GitHub de QMK](https://github.com/qmk/qmk_firmware), et vous verrez un bouton dans le coin en haut à droite qui indique "Fork": -![Fork on Github](http://i.imgur.com/8Toomz4.jpg) +![Fork on GitHub](http://i.imgur.com/8Toomz4.jpg) Si vous faites partie d'une organisation, vous aurez besoin de savoir quel compte utiliser pour le fork. Dans la plupart des cas, vous voudrez créer le fork dans votre compte personnel. Une fois le fork complet (cela peut quelques fois prendre un peu de temps), appuyez sur le bouton "Clone or download": -![Download from Github](http://i.imgur.com/N1NYcSz.jpg) +![Download from GitHub](http://i.imgur.com/N1NYcSz.jpg) Faites attention à sélectionner "HTTPS", et sélectionnez le lien et copiez-le: diff --git a/docs/fr-fr/newbs_best_practices.md b/docs/fr-fr/newbs_best_practices.md index 1491013147..ec68a5e3e5 100644 --- a/docs/fr-fr/newbs_best_practices.md +++ b/docs/fr-fr/newbs_best_practices.md @@ -44,7 +44,7 @@ git pull upstream master git push origin master ``` -Cela vous change la branche courante en master, synchronise les données de références du dépôt QMK vers votre ordinateur. La commande pull tire les données de références vers votre branche courante puis les y téleverse. La commande push permet de pousser la branche courante (master) vers votre fork github. +Cela vous change la branche courante en master, synchronise les données de références du dépôt QMK vers votre ordinateur. La commande pull tire les données de références vers votre branche courante puis les y téleverse. La commande push permet de pousser la branche courante (master) vers votre fork GitHub. ### Faire des changements diff --git a/docs/getting_started_github.md b/docs/getting_started_github.md index 07f523f578..ae594f68d8 100644 --- a/docs/getting_started_github.md +++ b/docs/getting_started_github.md @@ -1,16 +1,16 @@ -# How to Use Github with QMK +# How to Use GitHub with QMK -Github can be a little tricky to those that aren't familiar with it - this guide will walk through each step of forking, cloning, and submitting a pull request with QMK. +GitHub can be a little tricky to those that aren't familiar with it - this guide will walk through each step of forking, cloning, and submitting a pull request with QMK. ?> This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system. -Start on the [QMK Github page](https://github.com/qmk/qmk_firmware), and you'll see a button in the upper right that says "Fork": +Start on the [QMK GitHub page](https://github.com/qmk/qmk_firmware), and you'll see a button in the upper right that says "Fork": -![Fork on Github](http://i.imgur.com/8Toomz4.jpg) +![Fork on GitHub](http://i.imgur.com/8Toomz4.jpg) If you're a part of an organization, you'll need to choose which account to fork it to. In most circumstances, you'll want to fork it to your personal account. Once your fork is completed (sometimes this takes a little while), click the "Clone or Download" button: -![Download from Github](http://i.imgur.com/N1NYcSz.jpg) +![Download from GitHub](http://i.imgur.com/N1NYcSz.jpg) And be sure to select "HTTPS", and select the link and copy it: @@ -54,7 +54,7 @@ To https://github.com/whoeveryouare/qmk_firmware.git + 20043e64...7da94ac5 master -> master ``` -Your changes now exist on your fork on Github - if you go back there (`https://github.com//qmk_firmware`), you can create a "New Pull Request" by clicking this button: +Your changes now exist on your fork on GitHub - if you go back there (`https://github.com//qmk_firmware`), you can create a "New Pull Request" by clicking this button: ![New Pull Request](http://i.imgur.com/DxMHpJ8.jpg) diff --git a/docs/he-il/README.md b/docs/he-il/README.md index 8e0c470b44..c16801b2bd 100644 --- a/docs/he-il/README.md +++ b/docs/he-il/README.md @@ -14,7 +14,7 @@ QMK (*Quantum Mechanical Keyboard*) היא קהילת קוד פתוח (open sour ## איך להשיג אותה -אם אתם מתכננים לתרום מיפוי מקשים, מקלדת או יכולת ל QMK, הדבר הקל ביותר הוא [לעשות פורק לריפו בGithub](https://github.com/qmk/qmk_firmware#fork-destination-box), ולעשות קלון לריפו בסביבה המקומית ושם לבצע את השינויים שלכם, לדחוף אותם ולפתוח [Pull Request](https://github.com/qmk/qmk_firmware/pulls) מהפורק שלך. +אם אתם מתכננים לתרום מיפוי מקשים, מקלדת או יכולת ל QMK, הדבר הקל ביותר הוא [לעשות פורק לריפו בGitHub](https://github.com/qmk/qmk_firmware#fork-destination-box), ולעשות קלון לריפו בסביבה המקומית ושם לבצע את השינויים שלכם, לדחוף אותם ולפתוח [Pull Request](https://github.com/qmk/qmk_firmware/pulls) מהפורק שלך. אחרת, אפשר להוריד את הקושחה באופן ישיר ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), או לשכפל אותה באמצעות git (`git@github.com:qmk/qmk_firmware.git`), או https (`https://github.com/qmk/qmk_firmware.git`). diff --git a/docs/he-il/_summary.md b/docs/he-il/_summary.md index bdacd0d1fd..148eb6400d 100644 --- a/docs/he-il/_summary.md +++ b/docs/he-il/_summary.md @@ -5,7 +5,7 @@ * [מקורות ללמידה](he-il/newbs_learn_more_resources.md) * [בסיס QMK](he-il/README.md) * [מבוא לQMK](he-il/getting_started_introduction.md) - * [איך להשתמש בGithub](he-il/getting_started_github.md) + * [איך להשתמש בGitHub](he-il/getting_started_github.md) * [קבלת עזרה](he-il/getting_started_getting_help.md) * [שאלות נפוצות](he-il/faq.md) * [שאלות נפוצות כלליות](he-il/faq_general.md) @@ -27,7 +27,7 @@ * [QMK CLI](he-il/cli.md) * [QMK CLI Config](he-il/cli_configuration.md) * [תרומה ל QMK](he-il/contributing.md) - * [איך להשתמש בGithub](he-il/getting_started_github.md) + * [איך להשתמש בGitHub](he-il/getting_started_github.md) * [קבלת עזרה](he-il/getting_started_getting_help.md) * [שינויים משמעותיים](he-il/breaking_changes.md) diff --git a/docs/he-il/getting_started_getting_help.md b/docs/he-il/getting_started_getting_help.md index 1a2edc3133..e62c9f403d 100644 --- a/docs/he-il/getting_started_getting_help.md +++ b/docs/he-il/getting_started_getting_help.md @@ -11,7 +11,7 @@ הפורום הרשמי של QMK נמצא ב - [/r/olkb](https://reddit.com/r/olkb) באתר [reddit.com](https://reddit.com). -## סוגיות Github +## סוגיות GitHub ניתן לפתוח [סוגייה ב-GitHub](https://github.com/qmk/qmk_firmware/issues). הדבר שימושי במיוחד כאשר הסוגיה דורשת דיון עמוק וארוך או דיבאגינג. \ No newline at end of file diff --git a/docs/he-il/getting_started_github.md b/docs/he-il/getting_started_github.md index e5d0f7c782..5cafac5ac5 100644 --- a/docs/he-il/getting_started_github.md +++ b/docs/he-il/getting_started_github.md @@ -1,17 +1,17 @@
-# איך להשתמש ב-Github עם QMK +# איך להשתמש ב-GitHub עם QMK -Github עלול להיות קצת טריקי למי שלא מכיר את העבודה איתו - מדריך זה ילווה אתכם שלב אחר שלב דרך ביצוע פעולות fork, clone ו-pull request עם QMK. +GitHub עלול להיות קצת טריקי למי שלא מכיר את העבודה איתו - מדריך זה ילווה אתכם שלב אחר שלב דרך ביצוע פעולות fork, clone ו-pull request עם QMK. ?> מדריך זה מניח שאתם מרגישים בנוח עם הרצה של פקודות בסביבת command line (שורת הפקודה) ו-git מותקן במערכת שלכם. -התחילו ב- [עמוד של QMK ב-Github](https://github.com/qmk/qmk_firmware), ותצמאו כפתור בחלק העליון מימין עם התיכוב "Fork": +התחילו ב- [עמוד של QMK ב-GitHub](https://github.com/qmk/qmk_firmware), ותצמאו כפתור בחלק העליון מימין עם התיכוב "Fork": -![Fork ב-Github](http://i.imgur.com/8Toomz4.jpg) +![Fork ב-GitHub](http://i.imgur.com/8Toomz4.jpg) אם אתם חלק מארגון, תצטרכו לבחור לאיזה חשבון לבצע פעולת fork. ברוב המבקרים, תרצו לבצע fork לתוך החשבון הפרטי שלכם. ברגע שה-fork הסתיים (לפעמים זה יכול לקחת קצת זמן) הקליקו על כפתור ה-"Clone or Download": -![הורדה מ-Github](http://i.imgur.com/N1NYcSz.jpg) +![הורדה מ-GitHub](http://i.imgur.com/N1NYcSz.jpg) תוודאו שאתם בוחרים באופצייה של "HTTPS", בחרו את הקישור והעתיקו אותו: diff --git a/docs/ja/cli_configuration.md b/docs/ja/cli_configuration.md index 7e9c3e57fa..d21a27596d 100644 --- a/docs/ja/cli_configuration.md +++ b/docs/ja/cli_configuration.md @@ -113,7 +113,7 @@ compile.keymap: skully -> None |-----|---------------|-------------| | user.keyboard | None | キーボードのパス (例: `clueboard/66/rev4`) | | user.keymap | None | キーマップ名 (例: `default`) | -| user.name | None | ユーザの github のユーザ名。 | +| user.name | None | ユーザの GitHub のユーザ名。 | # 全ての設定オプション diff --git a/docs/ja/getting_started_github.md b/docs/ja/getting_started_github.md index 5457c1e06e..24a217c745 100644 --- a/docs/ja/getting_started_github.md +++ b/docs/ja/getting_started_github.md @@ -1,15 +1,15 @@ -# QMK で Github を使う方法 +# QMK で GitHub を使う方法 -Github は慣れていない人には少し注意が必要です - このガイドは、QMK におけるフォーク、クローン、プルリクエストのサブミットの各ステップについて説明します。 +GitHub は慣れていない人には少し注意が必要です - このガイドは、QMK におけるフォーク、クローン、プルリクエストのサブミットの各ステップについて説明します。 ?> このガイドでは、あなたがコマンドラインでの実行にある程度慣れており、システムに git がインストールされていることを前提にしています。 -[QMK Github ページ](https://github.com/qmk/qmk_firmware)を開くと、右上に "Fork" というボタンが見えます: +[QMK GitHub ページ](https://github.com/qmk/qmk_firmware)を開くと、右上に "Fork" というボタンが見えます: ![Git でのフォーク](http://i.imgur.com/8Toomz4.jpg) @@ -59,7 +59,7 @@ To https://github.com/whoeveryouare/qmk_firmware.git + 20043e64...7da94ac5 master -> master ``` -あなたの変更は今では Github 上のフォークにあります - フォーク (`https://github.com//qmk_firmware`)に戻ると、"New Pull Request" ボタンをクリックすることで新しいプルリクエストを作成することができます: +あなたの変更は今では GitHub 上のフォークにあります - フォーク (`https://github.com//qmk_firmware`)に戻ると、"New Pull Request" ボタンをクリックすることで新しいプルリクエストを作成することができます: ![New Pull Request](http://i.imgur.com/DxMHpJ8.jpg) diff --git a/docs/ja/newbs_building_firmware_configurator.md b/docs/ja/newbs_building_firmware_configurator.md index e54921e520..419ba1416b 100644 --- a/docs/ja/newbs_building_firmware_configurator.md +++ b/docs/ja/newbs_building_firmware_configurator.md @@ -28,7 +28,7 @@ QMK Configurator は Chrome/Firefox で最適に動作します。 キーボードが QMK を搭載していると宣伝されていてもリストにない場合は、開発者がまだ作業中か、私たちがまだマージするきっかけがなかった可能性があります。 アクティブな [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) がない場合、[qmk_firmware](https://github.com/qmk/qmk_firmware/issues)で報告して、その特定のキーボードのサポートをリクエストします。 -製作者自身の github アカウントにある QMK 搭載キーボードもあります。 +製作者自身の GitHub アカウントにある QMK 搭載キーボードもあります。 それも再確認してください。 ## キーボードのレイアウトを選択する diff --git a/docs/ja/newbs_learn_more_resources.md b/docs/ja/newbs_learn_more_resources.md index 523d91a05a..f2f8270e1d 100644 --- a/docs/ja/newbs_learn_more_resources.md +++ b/docs/ja/newbs_learn_more_resources.md @@ -14,7 +14,7 @@ * [Great General Tutorial](https://www.codecademy.com/learn/learn-git) * [Git Game To Learn From Examples](https://learngitbranching.js.org/) -* [Git Resources to Learn More About Github](getting_started_github.md) +* [Git Resources to Learn More About GitHub](getting_started_github.md) * [Git Resources Aimed Specifically toward QMK](contributing.md) ### 日本語 @@ -22,7 +22,7 @@ _日本語のリソース情報を募集中です。_ * [Git Game To Learn From Examples(日本語対応有り)](https://learngitbranching.js.org/) -* [QMK で Github を使う方法](ja/getting_started_github.md) +* [QMK で GitHub を使う方法](ja/getting_started_github.md) * [貢献方法](ja/contributing.md) ## コマンドラインに関するリソース: diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 83df2f3050..1367d1b409 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -135,7 +135,7 @@ Most people new to QMK only have 1 keyboard. You can set this keyboard as your d qmk config user.keyboard=clueboard/66/rev4 -You can also set your default keymap name. Most people use their github username here, and we recommend that you do too. +You can also set your default keymap name. Most people use their GitHub username here, and we recommend that you do too. qmk config user.keymap= diff --git a/docs/other_vscode.md b/docs/other_vscode.md index 7427f758e5..d544db6307 100644 --- a/docs/other_vscode.md +++ b/docs/other_vscode.md @@ -102,7 +102,7 @@ There are a number of extensions that you may want to install: This installs a bunch of Git related tools that may make using Git with QMK Firmware easier. * [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) - _[Optional]_ - Helps to keep the code to the QMK Coding Conventions. * [Bracket Pair Colorizer 2](https://marketplace.visualstudio.com/items?itemName=CoenraadS.bracket-pair-colorizer-2) - _[Optional]_ - This color codes the brackets in your code, to make it easier to reference nested code. -* [Github Markdown Preview](https://marketplace.visualstudio.com/items?itemName=bierner.github-markdown-preview) - _[Optional]_ - Makes the markdown preview in VS Code more like GitHub's. +* [GitHub Markdown Preview](https://marketplace.visualstudio.com/items?itemName=bierner.github-markdown-preview) - _[Optional]_ - Makes the markdown preview in VS Code more like GitHub's. * [VS Live Share Extension Pack](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare-pack) - _[Optional]_ - This extension allows somebody else to access your workspace (or you to access somebody else's workspace) and help out. This is great if you're having issues and need some help from somebody. * [VIM Keymap](https://marketplace.visualstudio.com/items?itemName=GiuseppeCesarano.vim-keymap) - _[Optional]_ - For those that prefer VIM style keybindings. There are other options for this, too. * [Travis CI Status](https://marketplace.visualstudio.com/items?itemName=felixrieseberg.vsc-travis-ci-status) - _[Optional]_ - This shows the current Travis CI status, if you have it set up. diff --git a/docs/pt-br/README.md b/docs/pt-br/README.md index 7cff6ce621..ea63ce13b5 100644 --- a/docs/pt-br/README.md +++ b/docs/pt-br/README.md @@ -12,7 +12,7 @@ QMK (*Quantum Mechanical Keyboard*) é uma comunidade de código aberto que mant ## Como obter e usar o QMK -Se você planeja contribuir com um _keymap_ ("mapa de teclas"), teclado ou recursos para o QMK, o jeito mais fácil é [percorrer o repositório através do Github](https://github.com/qmk/qmk_firmware#fork-destination-box) e clonar seu repositório localmente para fazer suas alterações, dê um _push_ nelas e abra uma [_Pull request_](https://github.com/qmk/qmk_firmware/pulls) no seu fork. +Se você planeja contribuir com um _keymap_ ("mapa de teclas"), teclado ou recursos para o QMK, o jeito mais fácil é [percorrer o repositório através do GitHub](https://github.com/qmk/qmk_firmware#fork-destination-box) e clonar seu repositório localmente para fazer suas alterações, dê um _push_ nelas e abra uma [_Pull request_](https://github.com/qmk/qmk_firmware/pulls) no seu fork. Caso contrário, você pode cloná-lo diretamente com `git clone https://github.com/qmk/qmk_firmware`. Não faça o download dos arquivos zip ou tar; é necessário um repositório git para baixar os submódulos para compilar. diff --git a/docs/pt-br/_summary.md b/docs/pt-br/_summary.md index 78b3b20216..e0a1b45b33 100644 --- a/docs/pt-br/_summary.md +++ b/docs/pt-br/_summary.md @@ -11,7 +11,7 @@ * [QMK CLI](pt-br/cli.md) * [QMK CLI Config](pt-br/cli_configuration.md) * [Contributing to QMK](pt-br/contributing.md) - * [How to Use Github](pt-br/getting_started_github.md) + * [How to Use GitHub](pt-br/getting_started_github.md) * [Getting Help](pt-br/getting_started_getting_help.md) * [Breaking Changes](pt-br/breaking_changes.md) diff --git a/docs/ru-ru/_summary.md b/docs/ru-ru/_summary.md index f893be3cfd..09273172b6 100644 --- a/docs/ru-ru/_summary.md +++ b/docs/ru-ru/_summary.md @@ -11,7 +11,7 @@ * [QMK CLI](ru-ru/cli.md) * [QMK CLI Config](ru-ru/cli_configuration.md) * [Contributing to QMK](ru-ru/contributing.md) - * [How to Use Github](ru-ru/getting_started_github.md) + * [How to Use GitHub](ru-ru/getting_started_github.md) * [Getting Help](ru-ru/getting_started_getting_help.md) * [Breaking Changes](ru-ru/breaking_changes.md) diff --git a/docs/ru-ru/getting_started_github.md b/docs/ru-ru/getting_started_github.md index 3b4940dd15..4fd80791f1 100644 --- a/docs/ru-ru/getting_started_github.md +++ b/docs/ru-ru/getting_started_github.md @@ -6,10 +6,10 @@ GitHub может показаться несколько сложным для Откройте [страницу QMK на GitHub] (https://github.com/qmk/qmk_firmware), и в правом верхнем углу вы увидите кнопку с надписью "Fork": -![Fork on Github](http://i.imgur.com/8Toomz4.jpg) +![Fork on GitHub](http://i.imgur.com/8Toomz4.jpg) Если вы состоите в какой-либо организации, вам нужно выбрать учетную запись, к которой будет привязан форк. В большинстве случаев это будет личной аккаунт. Как только ваш форк будет завершен (иногда это занимает немного времени), нажмите кнопку "Clone or Download": -![Download from Github](http://i.imgur.com/N1NYcSz.jpg) +![Download from GitHub](http://i.imgur.com/N1NYcSz.jpg) И обязательно выберите "HTTPS", затем выделите ссылку и скопируйте ее: diff --git a/docs/support.md b/docs/support.md index 79c1dbc1b5..938d9daf78 100644 --- a/docs/support.md +++ b/docs/support.md @@ -12,6 +12,6 @@ If you need help with something, the best place to get quick support is going to The official QMK forum is [/r/olkb](https://reddit.com/r/olkb) on [reddit.com](https://reddit.com). -## Github Issues +## GitHub Issues You can open an [issue on GitHub](https://github.com/qmk/qmk_firmware/issues). This is especially handy when your issue will require long-term discussion or debugging. diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index bb7e0130f0..173af882da 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -13,7 +13,7 @@ QMK (*Quantum Mechanical Keyboard*) 是一个社区维护的开源软件，包 ## 如何得到它 -如果你打算贡献布局, 键盘, 或者其他QMK特性, 一下是最简单的方法：[从Github获得repo分支](https://github.com/qmk/qmk_firmware#fork-destination-box), 并克隆你的repo到本地进行编辑，推送，然后从你的分支打开 [Pull Request](https://github.com/qmk/qmk_firmware/pulls). +如果你打算贡献布局, 键盘, 或者其他QMK特性, 一下是最简单的方法：[从GitHub获得repo分支](https://github.com/qmk/qmk_firmware#fork-destination-box), 并克隆你的repo到本地进行编辑，推送，然后从你的分支打开 [Pull Request](https://github.com/qmk/qmk_firmware/pulls). 此外, 你也可以直接下载 ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), 或者从git克隆 (`git@github.com:qmk/qmk_firmware.git`), 或 https (`https://github.com/qmk/qmk_firmware.git`). diff --git a/docs/zh-cn/_summary.md b/docs/zh-cn/_summary.md index 201b83894d..cedcfbd525 100644 --- a/docs/zh-cn/_summary.md +++ b/docs/zh-cn/_summary.md @@ -14,7 +14,7 @@ * [QMK命令行工具](zh-cn/cli.md) * [QMK命令行工具配置](zh-cn/cli_configuration.md) * [向QMK贡献代码](zh-cn/contributing.md) - * [如何使用Github](zh-cn/getting_started_github.md) + * [如何使用GitHub](zh-cn/getting_started_github.md) * [获得帮助](zh-cn/getting_started_getting_help.md) * [非兼容性修改](zh-cn/breaking_changes.md) diff --git a/docs/zh-cn/getting_started_getting_help.md b/docs/zh-cn/getting_started_getting_help.md index cf770a7708..8c0ebaa243 100644 --- a/docs/zh-cn/getting_started_getting_help.md +++ b/docs/zh-cn/getting_started_getting_help.md @@ -10,6 +10,6 @@ QMK的官方论坛是[/r/olkb](https://reddit.com/r/olkb) 在[reddit.com](https://reddit.com)上. -## Github的Issue +## GitHub的Issue 你可以在GitHub上 [提出issue](https://github.com/qmk/qmk_firmware/issues).当您的问题需要长期讨论或调试时，这尤其方便。 diff --git a/docs/zh-cn/getting_started_github.md b/docs/zh-cn/getting_started_github.md index 2b2f7a75c5..9a01e43b7f 100644 --- a/docs/zh-cn/getting_started_github.md +++ b/docs/zh-cn/getting_started_github.md @@ -1,16 +1,16 @@ -# 如何在QMK中使用Github +# 如何在QMK中使用GitHub -Github can be a little tricky to those that aren't familiar with it - this guide will walk through each step of forking, cloning, and submitting a pull request with QMK. +GitHub can be a little tricky to those that aren't familiar with it - this guide will walk through each step of forking, cloning, and submitting a pull request with QMK. ?> 本教程假设您已安装GitHub，并且您喜欢使用命令行工作。 -首先 [Github上的QMK页面](https://github.com/qmk/qmk_firmware), 您能看到右上方有个按钮写着"Fork": +首先 [GitHub上的QMK页面](https://github.com/qmk/qmk_firmware), 您能看到右上方有个按钮写着"Fork": -![从Github上分叉](http://i.imgur.com/8Toomz4.jpg) +![从GitHub上分叉](http://i.imgur.com/8Toomz4.jpg) 如果你是某组织成员，你将需要选择分叉到哪个账户。一般情况下, 你是想要分叉到你的私人账户下。当你完成分叉 (有时需要等一会), 点击"Clone or Download" 按钮: -!从Github下载](http://i.imgur.com/N1NYcSz.jpg) +!从GitHub下载](http://i.imgur.com/N1NYcSz.jpg) 你要选择 "HTTPS", 然后选择链接复制: @@ -54,7 +54,7 @@ To https://github.com/whoeveryouare/qmk_firmware.git + 20043e64...7da94ac5 master -> master ``` -现在你的改动已经在你Github上的分支中了 - 如果你回到这 (`https://github.com/你的GitHub账户名/qmk_firmware`) ,你可以点击下方所示按钮创建 "New Pull Request": +现在你的改动已经在你GitHub上的分支中了 - 如果你回到这 (`https://github.com/你的GitHub账户名/qmk_firmware`) ,你可以点击下方所示按钮创建 "New Pull Request": ![新的 Pull Request](http://i.imgur.com/DxMHpJ8.jpg) diff --git a/docs/zh-cn/newbs_building_firmware.md b/docs/zh-cn/newbs_building_firmware.md index 31093f2543..fc43583c2b 100644 --- a/docs/zh-cn/newbs_building_firmware.md +++ b/docs/zh-cn/newbs_building_firmware.md @@ -20,7 +20,7 @@ ## 创建`default` 布局副本 -打开`keymaps`文件夹后，您将需要创建`default`文件夹的副本。我们强烈建议您将文件夹命名为与Github用户名相同的名称，但您也可以使用任何您想使用的名称，只要它只包含小写字母、数字和下划线字符。 +打开`keymaps`文件夹后，您将需要创建`default`文件夹的副本。我们强烈建议您将文件夹命名为与GitHub用户名相同的名称，但您也可以使用任何您想使用的名称，只要它只包含小写字母、数字和下划线字符。 要自动执行此过程，您还可以选择运行`new_keymap.sh`脚本。 diff --git a/drivers/avr/apa102.c b/drivers/avr/apa102.c index b174b39b8f..740acb5739 100644 --- a/drivers/avr/apa102.c +++ b/drivers/avr/apa102.c @@ -2,7 +2,7 @@ * APA102 lib V1.0a * * Controls APA102 RGB-LEDs - * Author: Mikkel (Duckle29 on github) + * Author: Mikkel (Duckle29 on GitHub) * * Dec 22th, 2017 v1.0a Initial Version * diff --git a/drivers/avr/i2c_master.c b/drivers/avr/i2c_master.c index c084d5754f..b1e4885298 100644 --- a/drivers/avr/i2c_master.c +++ b/drivers/avr/i2c_master.c @@ -14,7 +14,7 @@ * along with this program. If not, see . */ /* Library made by: g4lvanix - * Github repository: https://github.com/g4lvanix/I2C-master-lib + * GitHub repository: https://github.com/g4lvanix/I2C-master-lib */ #include diff --git a/drivers/avr/i2c_master.h b/drivers/avr/i2c_master.h index 0a3b6c508c..4a35867cd0 100644 --- a/drivers/avr/i2c_master.h +++ b/drivers/avr/i2c_master.h @@ -14,7 +14,7 @@ * along with this program. If not, see . */ /* Library made by: g4lvanix - * Github repository: https://github.com/g4lvanix/I2C-master-lib + * GitHub repository: https://github.com/g4lvanix/I2C-master-lib */ #ifndef I2C_MASTER_H diff --git a/drivers/avr/i2c_slave.c b/drivers/avr/i2c_slave.c index 3fb684f70a..62a378165a 100644 --- a/drivers/avr/i2c_slave.c +++ b/drivers/avr/i2c_slave.c @@ -14,7 +14,7 @@ * along with this program. If not, see . */ /* Library made by: g4lvanix - * Github repository: https://github.com/g4lvanix/I2C-slave-lib + * GitHub repository: https://github.com/g4lvanix/I2C-slave-lib */ #include diff --git a/drivers/avr/i2c_slave.h b/drivers/avr/i2c_slave.h index 5ed0b11a8e..5d92150e65 100644 --- a/drivers/avr/i2c_slave.h +++ b/drivers/avr/i2c_slave.h @@ -14,7 +14,7 @@ * along with this program. If not, see . */ /* Library made by: g4lvanix - * Github repository: https://github.com/g4lvanix/I2C-slave-lib + * GitHub repository: https://github.com/g4lvanix/I2C-slave-lib Info: Inititate the library by giving the required address. Read or write to the necessary buffer according to the opperation. diff --git a/keyboards/8pack/readme.md b/keyboards/8pack/readme.md index ad5df536a1..9c608e2a59 100644 --- a/keyboards/8pack/readme.md +++ b/keyboards/8pack/readme.md @@ -4,7 +4,7 @@ An open source 2x4 macropad designed by Charles Garcia. Keyboard Maintainer: [Charles Garcia](https://github.com/cgarcia2097) Hardware Supported: 8-Pack Macropad PCB -Hardware Availability: [8-Pack Github](https://github.com/cgarcia2097/8-Pack) +Hardware Availability: [8-Pack GitHub](https://github.com/cgarcia2097/8-Pack) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/abacus/readme.md b/keyboards/abacus/readme.md index 1f58a25a4a..ecf25b2edf 100644 --- a/keyboards/abacus/readme.md +++ b/keyboards/abacus/readme.md @@ -6,7 +6,7 @@ A first attempt at a PCB design for a mechanical keyboard. Includes rotary encod * Keyboard Maintainer: [nickolaij](https://github.com/nickolaij) * Hardware Supported: Abacus PCB, [Elite C Microcontroller](https://keeb.io/products/elite-c-usb-c-pro-micro-replacement-arduino-compatible-atmega32u4) or Pro Micro Microcontroller (Elite C has additional pins for encoder) -* Hardware Availability: [Abacus PCB Github](https://github.com/nickolaij/Abacus_Rev2) +* Hardware Availability: [Abacus PCB GitHub](https://github.com/nickolaij/Abacus_Rev2) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/allison/readme.md b/keyboards/allison/readme.md index 343ff2325d..60670cbad8 100644 --- a/keyboards/allison/readme.md +++ b/keyboards/allison/readme.md @@ -4,7 +4,7 @@ A custom luxurious 60 with F-row and Macro -* Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar) +* Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar) * Hardware Supported: ATmega32U4 * Hardware Availability: Small production run by mrpetrov#9585 and [protoTypist](https://discord.gg/UvskpBB) diff --git a/keyboards/allison_numpad/readme.md b/keyboards/allison_numpad/readme.md index 0226c44f68..82992339e1 100644 --- a/keyboards/allison_numpad/readme.md +++ b/keyboards/allison_numpad/readme.md @@ -4,7 +4,7 @@ A custom luxurious numpad to match Allison -* Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar) +* Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar) * Hardware Supported: ATmega32U4 * Hardware Availability: Small production run by mrpetrov#9585 and [protoTypist](https://discord.gg/UvskpBB) diff --git a/keyboards/alps64/readme.md b/keyboards/alps64/readme.md index 1188d7819c..4ad7bf3efe 100644 --- a/keyboards/alps64/readme.md +++ b/keyboards/alps64/readme.md @@ -6,7 +6,7 @@ Keyboard Maintainer: QMK Community Hardware Supported: Alps64 PCB Hardware Availability: https://geekhack.org/index.php?topic=69666.0 -QMK is not the Alps64 official firmware. To use the official tools, refer to [TMK Keymap Editor](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?alps64) or [TMK Keyboard Firmware on Github](https://github.com/tmk/tmk_keyboard). +QMK is not the Alps64 official firmware. To use the official tools, refer to [TMK Keymap Editor](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?alps64) or [TMK Keyboard Firmware on GitHub](https://github.com/tmk/tmk_keyboard). Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/baguette/readme.md b/keyboards/baguette/readme.md index e6188cc990..501f81b328 100644 --- a/keyboards/baguette/readme.md +++ b/keyboards/baguette/readme.md @@ -5,7 +5,7 @@ Baguette This is a custom keyboard with backlight inspired by France. -Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar) +Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar) Hardware Supported: ATMEGA 32u4 MCU with backlight support. Hardware Availability: Closed group-buy please contact the runners (Tesletron and Enjoy) diff --git a/keyboards/converter/siemens_tastatur/readme.md b/keyboards/converter/siemens_tastatur/readme.md index ca1b6ec0f3..651df9153f 100644 --- a/keyboards/converter/siemens_tastatur/readme.md +++ b/keyboards/converter/siemens_tastatur/readme.md @@ -4,7 +4,7 @@ A Blue Pill STM32F103C8T6-based Converter board for a very very old keyboard. -Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar) +Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar) Hardware Supported: Blue Pill STM32F103C8T6 Hardware Availability: Custom PCB available, contact me diff --git a/keyboards/gingham/readme.md b/keyboards/gingham/readme.md index d0c3e6fad7..089af1cf5e 100644 --- a/keyboards/gingham/readme.md +++ b/keyboards/gingham/readme.md @@ -4,7 +4,7 @@ A 60% keyboard with only through hole components. -Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar) +Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar) Hardware Supported: ATMEGA328p with vusb [PCB](https://github.com/yiancar/gingham_pcb) Hardware Availability: https://yiancar-designs.com/, https://novelkeys.xyz, https://mechboards.co.uk/ diff --git a/keyboards/handwired/fruity60/readme.md b/keyboards/handwired/fruity60/readme.md index ed476d2643..23aafc49ac 100644 --- a/keyboards/handwired/fruity60/readme.md +++ b/keyboards/handwired/fruity60/readme.md @@ -5,7 +5,7 @@ A 60% tsangan, split bs/rs keyboard designed to support the bluefruit 32u4 ble controller Keyboard Maintainer: [Yan-Fa Li](https://github.com/yanfali)
-Hardware Supported: [github](https://github.com/yanfali/fruity60)
+Hardware Supported: [GitHub](https://github.com/yanfali/fruity60)
Hardware Availability: You can make them yourself by downloading kicad and generating gerbers.
Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/handwired/mechboards_micropad/readme.md b/keyboards/handwired/mechboards_micropad/readme.md index 36230b1281..c669d0f0d9 100644 --- a/keyboards/handwired/mechboards_micropad/readme.md +++ b/keyboards/handwired/mechboards_micropad/readme.md @@ -3,7 +3,7 @@ Mechboards Micropad This was a freebie, use me and find out more about me :) -Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar) +Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar) Hardware Supported: ATMega32u4 Hardware Availability: Random mechboards.co.uk order and UK meetups! diff --git a/keyboards/hs60/v1/readme.md b/keyboards/hs60/v1/readme.md index cbf5f4faab..4b613e2a52 100644 --- a/keyboards/hs60/v1/readme.md +++ b/keyboards/hs60/v1/readme.md @@ -5,7 +5,7 @@ HS60 This is a standard fixed layout 60% PCB. It comes in two varians, ISO and ANSI and support full per-key RGB. -Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar) +Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar) Hardware Supported: HS60 ISO and ANSI PCBs with Atmega 32u4 Hardware Availability: https://mechboards.co.uk/shop/all/hs60-pcb/ diff --git a/keyboards/hs60/v2/readme.md b/keyboards/hs60/v2/readme.md index bd747b1f3c..f6f75cc7bf 100644 --- a/keyboards/hs60/v2/readme.md +++ b/keyboards/hs60/v2/readme.md @@ -5,7 +5,7 @@ HS60 V2.0 This is a standard fixed layout 60% PCB. It comes in three variants; ISO, ANSI and HHKB and support full per-key RGB. -Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar) +Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar) Hardware Supported: HS60 ISO, ANSI and HHKB PCBs with STM32F303CC Hardware Availability: http://groupbuys.mechboards.co.uk/shop/hs60-hotswap-60-pcb/ diff --git a/keyboards/keycapsss/o4l_5x12/readme.md b/keyboards/keycapsss/o4l_5x12/readme.md index 4b1ebb6c7c..16bdcc49f5 100644 --- a/keyboards/keycapsss/o4l_5x12/readme.md +++ b/keyboards/keycapsss/o4l_5x12/readme.md @@ -14,7 +14,7 @@ A ortholinear 5x12 keyboard made and sold by Keycapsss. [More info at Keycapsss. --- -- Keyboard Maintainer: BenRoe [Github](https://github.com/BenRoe) / [Twitter](https://twitter.com/ben_roe) +- Keyboard Maintainer: BenRoe [GitHub](https://github.com/BenRoe) / [Twitter](https://twitter.com/ben_roe) - Hardware Supported: Pro Micro - Hardware Availability: [Keycapsss.com](https://keycapsss.com) diff --git a/keyboards/keycapsss/plaid_pad/readme.md b/keyboards/keycapsss/plaid_pad/readme.md index ad38f119ce..76b4fa8e8e 100644 --- a/keyboards/keycapsss/plaid_pad/readme.md +++ b/keyboards/keycapsss/plaid_pad/readme.md @@ -5,7 +5,7 @@ A 4x4 numpad with only through hole components. It's a great companion to the Plaid keyboard by [hsgw](https://github.com/hsgw/) and heavily inspired by it. -* Keyboard Maintainer: BenRoe [Github](https://github.com/BenRoe) / [Twitter](https://twitter.com/keycapsss) +* Keyboard Maintainer: BenRoe [GitHub](https://github.com/BenRoe) / [Twitter](https://twitter.com/keycapsss) * Hardware Supported: ATmega328P with VUSB ([see Bootloader section](#Bootloader)) * Hardware Availability: [Keycapsss.com](https://keycapsss.com) diff --git a/keyboards/kv/revt/readme.md b/keyboards/kv/revt/readme.md index e2f463b37d..23abc78035 100644 --- a/keyboards/kv/revt/readme.md +++ b/keyboards/kv/revt/readme.md @@ -5,7 +5,7 @@ A open source southpaw keyboard. The Default layer is a standard 104 ANSI keyboard just the numpad is on the left. There is a fn layer (its not in the layout image but in the keymap file) it adds media keys, f13-f24, and mouse keys. -[More info on KVT github](https://github.com/Hybrid65/KVT) +[More info on KVT GitHub](https://github.com/Hybrid65/KVT) * Keyboard Maintainer: [Neil Feagan](https://github.com/Hybrid65) * Hardware Supported: KVT, Proton C diff --git a/keyboards/maartenwut/mx5160/readme.md b/keyboards/maartenwut/mx5160/readme.md index 40753a8f55..3b0e15d7e5 100644 --- a/keyboards/maartenwut/mx5160/readme.md +++ b/keyboards/maartenwut/mx5160/readme.md @@ -5,7 +5,7 @@ ## Support * Keyboard Maintainer: [Maarten Dekkers](https://github.com/maartenwut) * Hardware Supported: mx-5160 (Chicony 5160c case) -* Hardware Availability: [Github](https://github.com/Maartenwut/mx-5160) +* Hardware Availability: [GitHub](https://github.com/Maartenwut/mx-5160) ## Build Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/mc_76k/readme.md b/keyboards/mc_76k/readme.md index be9b5c5ec6..e9577ebc9b 100644 --- a/keyboards/mc_76k/readme.md +++ b/keyboards/mc_76k/readme.md @@ -4,7 +4,7 @@ O-Ring suspended 60% with F-row keyboard -* Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar) +* Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar) * Hardware Supported: ATmega32U4 * Hardware Availability: GB run by [mustcode](https://www.reddit.com/user/mustcode). More info on [geekhack](https://geekhack.org/index.php?topic=101040.50) diff --git a/keyboards/meson/readme.md b/keyboards/meson/readme.md index 3824690c12..e5fdbad591 100644 --- a/keyboards/meson/readme.md +++ b/keyboards/meson/readme.md @@ -4,7 +4,7 @@ A 3x14 split keyboard with two thumb keys on each half. Supports MX, Alps, and C Keyboard Maintainer: [PyroL](https://github.com/PyrooL) Hardware Supported: Meson PCBs, Pro Micro -Hardware Availability: [open source at PyroL's Github](https://github.com/PyrooL/Meson) +Hardware Availability: [open source at PyroL's GitHub](https://github.com/PyrooL/Meson) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/nightmare/readme.md b/keyboards/nightmare/readme.md index 9e53ac5a92..0f9fcace8b 100644 --- a/keyboards/nightmare/readme.md +++ b/keyboards/nightmare/readme.md @@ -6,7 +6,7 @@ A 50% pseudo-TMO50 clone with an adjusted bottom row, designed on the cheap with Keyboard Maintainer: [cfbender](https://github.com/cfbender) Hardware Supported: Nightmare case and PCB -Hardware Availability: [Github](https://github.com/cfbender/keyboards/tree/master/nightmare) +Hardware Availability: [GitHub](https://github.com/cfbender/keyboards/tree/master/nightmare) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/nk65/readme.md b/keyboards/nk65/readme.md index 41f52615a7..5e7453a27d 100755 --- a/keyboards/nk65/readme.md +++ b/keyboards/nk65/readme.md @@ -5,7 +5,7 @@ NK65 This is a standard fixed layout 65% PCB. It supports VIA and full per-key RGB. -Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [github](https://github.com/yiancar) +Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar) Hardware Supported: A 65% keyboard with STM32F303CC Hardware Availability: https://novelkeys.xyz/ diff --git a/keyboards/pimentoso/paddino02/readme.md b/keyboards/pimentoso/paddino02/readme.md index 1e9518351a..c49508c7d7 100644 --- a/keyboards/pimentoso/paddino02/readme.md +++ b/keyboards/pimentoso/paddino02/readme.md @@ -2,7 +2,7 @@ 10-keys DIY mechanical macropad/gamepad. Features staggered columns, 2 thumb keys, symmetric PCB (you can build right-handed and left-handed versions with the same PCB). -Project page on Github, with build steps and 3d-printable files: +Project page on GitHub, with build steps and 3d-printable files: https://github.com/Pimentoso/Paddino02 diff --git a/keyboards/tg4x/readme.md b/keyboards/tg4x/readme.md index b1ce799512..a030033874 100644 --- a/keyboards/tg4x/readme.md +++ b/keyboards/tg4x/readme.md @@ -2,7 +2,7 @@ 40% sandwich keyboard driven by a pro micro. -For more info please refer to [MythosMann's Github](www.github.com/MythosMann/tg4x). +For more info please refer to [MythosMann's GitHub](www.github.com/MythosMann/tg4x). * Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) * Hardware Supported: TG4x v2.1 PCB diff --git a/keyboards/uranuma/readme.md b/keyboards/uranuma/readme.md index 3e78fa6fe6..6927b4ace1 100644 --- a/keyboards/uranuma/readme.md +++ b/keyboards/uranuma/readme.md @@ -5,7 +5,7 @@ It is a keyboard to input using fingers and palms. * Keyboard Maintainer: yohewi(yohewi@gmail.com) * Hardware Supported: UraNuma PCB -* Github [github.com/yohewi](https://github.com/yohewi) +* GitHub [github.com/yohewi](https://github.com/yohewi) * Hardware Availability: PCB, [Booth Shop](https://rt421.booth.pm/) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/vinta/readme.md b/keyboards/vinta/readme.md index 278c5e2c4b..a55395197e 100644 --- a/keyboards/vinta/readme.md +++ b/keyboards/vinta/readme.md @@ -6,7 +6,7 @@ Vinta This is an ARM-powered 65% keyboard PCB with USB Mini B connector and breakout for optional RGB underglow. -Keyboard Maintainer: [Peioris](http://peioris.space/) and on [github](https://github.com/coarse) +Keyboard Maintainer: [Peioris](http://peioris.space/) and on [GitHub](https://github.com/coarse) Hardware Supported: Vinta with STM32F042K6T6 Hardware Availability: Private Groupbuy (will post on Reddit once QMK has RGB underglow working) diff --git a/keyboards/wilba_tech/zeal60/readme.md b/keyboards/wilba_tech/zeal60/readme.md index 21d55af39b..2ae2787b72 100644 --- a/keyboards/wilba_tech/zeal60/readme.md +++ b/keyboards/wilba_tech/zeal60/readme.md @@ -5,7 +5,7 @@ Zeal60 This is a 60% PCB with per-key RGB LEDs and supports ANSI, ISO, winkey/winkeyless bottom row, HHKB-layout (split right shift and backspace). -Keyboard Maintainer: [Wilba](http://wilba.tech/) and on [github](https://github.com/Wilba6582) +Keyboard Maintainer: [Wilba](http://wilba.tech/) and on [GitHub](https://github.com/Wilba6582) Hardware Supported: Zeal60 PCB Rev 0-3 Hardware Availability: https://zealpc.net/collections/group-buy-pre-orders/products/zeal60rgb diff --git a/keyboards/wilba_tech/zeal65/readme.md b/keyboards/wilba_tech/zeal65/readme.md index 7441480384..63ff6abc36 100644 --- a/keyboards/wilba_tech/zeal65/readme.md +++ b/keyboards/wilba_tech/zeal65/readme.md @@ -5,7 +5,7 @@ Zeal65 This is a 65% PCB with per-key RGB LEDs and supports fixed, 1800-like bottom row and split backspace. It was designed for the Zephyr custom keyboard. -Keyboard Maintainer: [Wilba](http://wilba.tech/) and on [github](https://github.com/Wilba6582) +Keyboard Maintainer: [Wilba](http://wilba.tech/) and on [GitHub](https://github.com/Wilba6582) Hardware Supported: Zeal65 PCB Rev 1 Hardware Availability: https://zealpc.net/collections/group-buy-pre-orders/products/zephyr diff --git a/tmk_core/protocol/arm_atsam/led_matrix.c b/tmk_core/protocol/arm_atsam/led_matrix.c index c078980d68..24eab25067 100644 --- a/tmk_core/protocol/arm_atsam/led_matrix.c +++ b/tmk_core/protocol/arm_atsam/led_matrix.c @@ -326,7 +326,7 @@ const rgb_matrix_driver_t rgb_matrix_driver = {.init = init, .flush = flush, .se ==============================================================================*/ #ifdef USE_MASSDROP_CONFIGURATOR -// Ported from Massdrop QMK Github Repo +// Ported from Massdrop QMK GitHub Repo // TODO?: wire these up to keymap.c uint8_t led_animation_orientation = 0;