Update docs: QMK Introduction#3404
Conversation
I think this was a typo, or perhaps an older way to handle it.
This section didn't include the possibility of a user `config.h`, and it wasn't clear exactly how the settings override works.
|
@fredizzimo… would you mind making sure this is true and makes sense? |
fredizzimo
left a comment
fredizzimo
left a comment
There was a problem hiding this comment.
This looks good from my point of view.
But I would possibly reduce to boilerplate to just #pragma once, since it's supported by all our compilers there's much less risks of making mistakes with it.
drashna
left a comment
drashna
left a comment
There was a problem hiding this comment.
In the "Basic QMK Structure", it would be a good idea to add the Userspace structure too.
That's namely rules.mk, readme.md, and config.h.
@drashna mentioned it'd be good to have a mention of the userspace in the QMK structure section. Rather than rewrite the docs on userspace, I chose to link to the existing documentation.
According to @fredizzimo, this is a safer and easier way to handle the boilerplate.
|
@fredizzimo I've adjusted the boilerplate and the docs around it. I am correct in believing you don't need the @drashna I added a mention of the userspace to the section describing basic QMK structure. I just made a bare mention of it, and linked to the page of the docs describing the feature. |
|
Awesome - this should jump-start our switch to |
|
@jackhumbert @fredizzimo would it be worthwhile to migrate some of the popular "default" keymaps to use |
|
Yeah, I think it would be. But more importantly, it would be best to change the template's default: |
Making sure this is consistent with qmk#3404
* Update template config.h with `#pragma once` Making sure this is consistent with #3404 * Move to `#pragma once` for the other templates
* Update template config.h with `#pragma once` Making sure this is consistent with qmk#3404 * Move to `#pragma once` for the other templates
* Update template config.h with `#pragma once` Making sure this is consistent with qmk#3404 * Move to `#pragma once` for the other templates
* Update template config.h with `#pragma once` Making sure this is consistent with qmk#3404 * Move to `#pragma once` for the other templates
* Update template config.h with `#pragma once` Making sure this is consistent with qmk#3404 * Move to `#pragma once` for the other templates
4 participants
There was an artifact of the old build system on here… a reference to Makefile instead of
rules.mkReword the
config.hsectionThis section didn't include the possibility of a user
config.h, and itwasn't clear exactly how the settings override works.