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.

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

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

NBeing
Copy link

@NBeing NBeing commented Nov 30, 2024

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).

This will guide users with keyboards containing default keymaps in the `keymap.json` format towards generating a `keymap.c` file.
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)

Add link to json2c util.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants