mirror of https://github.com/firewalkwithm3/qmk_firmware.git synced 2024-11-23 03:50:28 +08:00

History

James Young a03aa301de Remove Full Bootmagic (#13846 ) * disambiguate Bootmagic rules in keymaps The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic. This commit edits the files to specify that full Bootmagic is intended. * remove BOOTMAGIC_ENABLE=full setting * unify commented BOOTMAGIC_ENABLE rules in keyboards Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;#[ \t]\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).;\1 = no # Virtual DIP switch configuration;g' {} + ``` * remove commented Bootmagic rules from keymap/user level Command: ``` find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\)./d' {} + ``` * update keyboard BOOTMAGIC_ENABLE rule formatting Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later). Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + ``` update keyboards' BOOTMAGIC_ENABLE settings Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' + ``` * update keymap/user BOOTMAGIC_ENABLE settings Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + ``` * remove and replace inline comments in keyboards and keymap/user files Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1 # Enable Bootmagic Lite;g' '{}' + ``` * rename improperly named makefiles Some files intended to be used as makefiles had improper names causing them to not be used as intended when building. This commit corrects the filenames of the affected files. * update renamed file with new rule formatting * update QMK's template files Updates QMK's `rules.mk` templates to use the new inline comment. * update QMK Docs - remove documentation of full Bootmagic - update links to Bootmagic Lite doc - add doc for Magic Keycodes * rules.mk patch for coarse/ixora and coarse/vinta		2021-08-06 23:59:56 -07:00
..
keymaps/default	[Keyboard] Add cool836A 1_2 (#11467 )	2021-01-14 22:27:21 -08:00
config.h	[Keyboard] Add cool836A 1_2 (#11467 )	2021-01-14 22:27:21 -08:00
cool836a.c	[Keyboard] Add cool836A 1_2 (#11467 )	2021-01-14 22:27:21 -08:00
cool836a.h	[Keyboard] Add cool836A 1_2 (#11467 )	2021-01-14 22:27:21 -08:00
info.json	[Keyboard] Add cool836A 1_2 (#11467 )	2021-01-14 22:27:21 -08:00
readme.md	[Keyboard] Add cool836A 1_2 (#11467 )	2021-01-14 22:27:21 -08:00
rules.mk	Remove Full Bootmagic (#13846 )	2021-08-06 23:59:56 -07:00

readme.md

cool836A

このプロジェクトの詳細については設計者たるm.ki様によるGitHubリポジトリの記述をご覧ください。

バージョン(A, B+, C+)について

m.ki様によるとどのバージョンも回路は同じで、ファームウェアを分ける必要はないとのことです。
しかしながらこのファームウェアは、cool836A ver.B+ (通称レッドバージョン)のみでテストされています(2021年1月7日現在)。そのため念のため、当面の間はサブフォルダの名前をcool836A/verB_REDとさせていただきます。
ほかのバージョンに書き込んだときに不具合等がありましたら、方はお気軽に私オオハシまでご連絡ください。

申し訳程度のチュートリアル

詳細に書き込む労力は払えませんでしたが、最低限のコードのみ記します。

git clone のあと、

make cool836A/verB_RED:default

でコンパイル可能であることを確認し、

make cool836A/verB_RED:default:avrdude

によってデフォルトキーマップをPro Microに焼けるかもしれません。 defaultの代わりにOhasheenを利用することもできます。

初心者の方はもっと素晴らしいウェブサイトでGitやqmk firmwareの使い方を覚えていただくのがよいかと思います。

English

Here are a full description of this project and build guide by the great Designer: [m.ki](imgur.com image replace me!)
Each virsions(A, B+, C+) of cool836A has the same circuit and that means you can install this firmware on any of them.
However, this repository is currently(Jan 7, 2021) tested on ver.B+ (RED version) only. Feel free to contact ME for any problems.
firmware maintainer: Ohashi

Such a humble tutorial

The author would like to provide a minimum guide.

After cloning the repository, you may want to

make cool836A/verB_RED

to make sure it's compilable, and

make cool836A/verB_RED:default

which leads you to the goal.

It is recommended that beginners learn how to get started with qmk firmware/configurator at other fantastic websites rather than here......