Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update newbs_building_firmware.md : Guide users whose keymaps are in .json format. #24663

Merged
merged 3 commits into from
Dec 22, 2024
Merged

Update newbs_building_firmware.md : Guide users whose keymaps are in .json format. #24663

merged 3 commits into from
Dec 22, 2024

Conversation

NBeing
Copy link
Contributor

@NBeing NBeing commented Nov 30, 2024 •
edited
Loading

Add information regarding keyboards whose default keymaps are .json

Description

This documentation update will better guide users with keyboards containing default keymaps in the keymap.json format towards generating a keymap.c file.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@NBeing
Update newbs_building_firmware.md
ea027d1 
This will guide users with keyboards containing default keymaps in the `keymap.json` format towards generating a `keymap.c` file.
plodah
plodah reviewed Nov 30, 2024
View reviewed changes
Copy link
Contributor

@plodah plodah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest linking json2c to the relevant docs page;

[`json2c`](cli_commands#qmk-json2c)

@NBeing
Update newbs_building_firmware.md
08abcd6 
Add link to json2c util.
@drashna drashna merged commit 58807b0 into qmk:master Dec 22, 2024
3 checks passed
ilham-agustiawan pushed a commit to ilham-agustiawan/qmk_firmware that referenced this pull request Dec 24, 2024
@NBeing @ilham-agustiawan
Clarify keymap location and format in newbs_building_firmware.md (qmk…
da28ce5 
…#24663)
dpnetca pushed a commit to dpnetca/qmk_firmware that referenced this pull request Dec 24, 2024
@NBeing
Clarify keymap location and format in newbs_building_firmware.md (qmk…
5e8bcec 
…#24663)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@plodah plodah plodah left review comments

@filterpaper filterpaper filterpaper left review comments

@waffle87 waffle87 waffle87 approved these changes

@drashna drashna drashna approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@NBeing @drashna @waffle87 @filterpaper @plodah