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 #23662

Closed
wants to merge 1 commit into from

Conversation

jacobjeffery
Copy link

@jacobjeffery jacobjeffery commented May 4, 2024

Fixed all of the .c references to .json

Description

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (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).

Fixed all of the .c references to .json

Open your `keymap.c` file in your text editor. Inside this file you'll find the structure that controls how your keyboard behaves. At the top of `keymap.c` there may be some defines and enums that make the keymap easier to read. Farther down you'll find a line that looks like this:
Open your `keymap.json` file in your text editor. Inside this file you'll find the structure that controls how your keyboard behaves. At the top of `keymap.c` there may be some defines and enums that make the keymap easier to read. Farther down you'll find a line that looks like this:
Copy link
Author

Choose a reason for hiding this comment

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

I missed the second .c reference in this paragraph.

Copy link
Member

@zvecr zvecr left a comment

Choose a reason for hiding this comment

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

The majority of keyboards still have the default keymap implemented with keymap.c, which is then used by qmk new-keymap. Also, the text blocks after these changes, still refer to typical keymap.c logic.

The change as it is right now, is more likely to confuse new users.

@zvecr zvecr added the wontfix label May 5, 2024
@jacobjeffery
Copy link
Author

Gotcha,. Thank you @zvecr. Admittedly I'm may have moved a bit too quickly here.

@zvecr zvecr closed this May 11, 2024
@zvecr
Copy link
Member

zvecr commented May 11, 2024

Closing for now as we will rework this area post #23451.

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.

2 participants