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

Updated hand wiring docs #5198

Merged
merged 2 commits into from
Feb 21, 2019
Merged

Conversation

johannes-jansson
Copy link
Contributor

Description

The main reason for this PR was to replace the outdated KEYMAP function with the newer LAYOUT function. The setup script referred to in the docs is already updated, so the name confused me.

While I was at it, I added links to the two best visual step by step guides on hand wiring. Let me know if that's discouraged and I will make changes accordingly. I have no affiliations with the users who wrote the guides.

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

Copy link
Contributor

@yanfali yanfali left a comment

Choose a reason for hiding this comment

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

LGTM

@noroadsleft
Copy link
Member

This has bothered me for a while. Thanks @johannes-jansson.

I'll probably make a run through the docs, because I know there are other instances of this issue in there. It's been driving me nuts for months.

@drashna
Copy link
Member

drashna commented Feb 21, 2019

Thanks!

@drashna drashna merged commit 9f1d781 into qmk:master Feb 21, 2019
zer09 pushed a commit to zer09/qmk_firmware that referenced this pull request Mar 2, 2019
* renamed KEYMAP to LAYOUT in hand wiring docs

* added two additional guides for hand wiring
slugger7 pushed a commit to slugger7/qmk_firmware that referenced this pull request Mar 7, 2019
* renamed KEYMAP to LAYOUT in hand wiring docs

* added two additional guides for hand wiring
slugger7 pushed a commit to slugger7/qmk_firmware that referenced this pull request Apr 3, 2019
* renamed KEYMAP to LAYOUT in hand wiring docs

* added two additional guides for hand wiring
dlhextall pushed a commit to dlhextall/qmk_firmware that referenced this pull request May 24, 2019
* renamed KEYMAP to LAYOUT in hand wiring docs

* added two additional guides for hand wiring
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.

4 participants