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

Keymap for XD75 with 7U spacebar EN-RU gamers #8184

Merged
merged 8 commits into from
Feb 19, 2020

Conversation

buzzlighter1
Copy link
Contributor

@buzzlighter1 buzzlighter1 commented Feb 16, 2020

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

@drashna drashna added the keymap label Feb 16, 2020
Copy link
Member

@drashna drashna left a comment

Choose a reason for hiding this comment

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

Just a couple of layer related cade changes, but otherwise LGTM.

keyboards/xd75/keymaps/buzzlighter1/keymap.c Outdated Show resolved Hide resolved
keyboards/xd75/keymaps/buzzlighter1/keymap.c Outdated Show resolved Hide resolved
buzzlighter1 and others added 2 commits February 16, 2020 22:25
Co-Authored-By: Drashna Jaelre <drashna@live.com>
Co-Authored-By: Drashna Jaelre <drashna@live.com>
@noroadsleft
Copy link
Member

noroadsleft commented Feb 17, 2020

To elaborate on my comment regarding the layers.json file:

That file contains the contents of the key assignments that are sent to the QMK Compiler API when a compile job is launched in QMK Configurator. When that happens, the keyboard, keymap name, and layout macro used are provided separately from this data. The file contains no information on its own that can be imported back into QMK Configurator. The only way to get further use from this file is to edit it by hand in a text editor, providing the keyboard, keymap name, and layout macro that were used on the original compile job.

If you were to export the keymap JSON from Configurator at the time of compiling, and compare it to the layers.json file, you will see that layers.json is a subset of the data in the export, while the export is the complete data set, and can be imported back into Configurator.


Also, for future reference, we recommend against committing to your master branch as you've done here, because pull requests from modified master branches can make it more difficult to keep your QMK fork updated. It is highly recommended for QMK development – regardless of what is being done or where – to keep your master updated, but NEVER commit to it. Instead, do all your changes in a branch (branches are basically free in Git) and issue PRs from your branches when you're developing.

There are instructions on how to keep your fork updated here:

Best Practices: Your Fork's Master: Update Often, Commit Never

If you need any help with this just ask.

You do not need to close this pull request at this time. Until your pull request is merged, please continue to commit relevant changes to your master branch.

@buzzlighter1
Copy link
Contributor Author

I suspected something like that about the layers.json file, thank you the explanation!

My goal was to make the keymap available to the public. I have followed the guide in the link mentioned above, but I thought I need to merge it into qmk:master to open it for the public. If the keymap in the buzzlighter1:master serves the goal then I probably should cancel this merge?...

@noroadsleft
Copy link
Member

Merging your keymap to qmk:master does make it more visible in my opinion, and later users may find something in your keymap they like.

If you want to include the JSON export from Configurator, that's fine and allowed, but it should be the keymap.json file with the complete data set, rather than the layers.json file.

Also, QMK's make system has the ability to compile keymap.json files into keymap.c files, so for ease of use, I'd suggest naming the keymap.json file to something more like buzzlighter1_keymap.json, because our CI system will compile the JSON instead of the C file if it finds both keymap.c and keymap.json in the same folder, and the C file supports more features.

There are some esoteric issues with Configurator keymap.json files, as far as compiling them through QMK Configurator. Those issues are documented here. (I really should make a doc for this.) Also, the first part of that post is also out of scope for your specific use case; you should scroll down to "You can't use default as the value for the keymap key" and read from there.

@drashna drashna requested a review from a team February 19, 2020 09:21
@drashna drashna requested a review from a team February 19, 2020 09:23
@noroadsleft
Copy link
Member

@buzzlighter1 If you want to contribute a QMK Configurator keymap file, additional pull requests are accepted.

I'm going to merge this; you should resynchronize your master branch now.

Thanks!

@noroadsleft noroadsleft merged commit 19c9141 into qmk:master Feb 19, 2020
HokieGeek pushed a commit to HokieGeek/qmk_firmware that referenced this pull request Feb 21, 2020
* Create readme.md

* Create keymap.c

* Create config.h

* Create rules.mk

* Create layers.json

* Update keyboards/xd75/keymaps/buzzlighter1/keymap.c

* Update keyboards/xd75/keymaps/buzzlighter1/keymap.c

* Delete layers.json
nesth pushed a commit to nesth/qmk_firmware that referenced this pull request Feb 21, 2020
* upstream/master: (330 commits)
  Add Danish keymap and sendstring LUT (qmk#8218)
  format code according to conventions [skip ci]
  uart.c fix from TMK (qmk#7628)
  S75 Encoder Fixes (qmk#7758)
  Add Turkish keymap aliases and sendstring LUT (qmk#7676)
  Add Arm Teensys to mcu_selection.mk (qmk#8026)
  [New keyboard]silverbullet44 (qmk#7950)
  Allow 30us matrix delay to be keyboard/user overridable  (qmk#8216)
  Merge /prime_l and /prime_l_v2 (qmk#8194)
  [Keymap] Keymap for XD75 with 7U spacebar EN-RU gamers (qmk#8184)
  Add VIA support for kbd8x mk2 (qmk#8168)
  Move Grave/Tilde and some lesser used keys on my ergo boards (qmk#8200)
  [Keyboard] KC60SE cleanup (qmk#8171)
  Made windows driver installation accept y as All to allow CI (qmk#8189)
  Change the image photo of /keyboards/reviung41/readme.md (qmk#8195)
  MxSS RGB Handler Touchup (qmk#8105)
  Centromere Configurator layout support and readme update (qmk#8190)
  dynamic keymap sanity check (qmk#8181)
  [keyboard] Austin (qmk#8176)
  Use pathlib everywhere we can (qmk#7872)
  ...
sowbug pushed a commit to sowbug/qmk_firmware that referenced this pull request Feb 23, 2020
* Create readme.md

* Create keymap.c

* Create config.h

* Create rules.mk

* Create layers.json

* Update keyboards/xd75/keymaps/buzzlighter1/keymap.c

* Update keyboards/xd75/keymaps/buzzlighter1/keymap.c

* Delete layers.json
nesth pushed a commit to nesth/qmk_firmware that referenced this pull request Feb 27, 2020
* 'master' of https://github.com/nesth/qmk_firmware: (331 commits)
  helix like crkbd
  Add Danish keymap and sendstring LUT (qmk#8218)
  format code according to conventions [skip ci]
  uart.c fix from TMK (qmk#7628)
  S75 Encoder Fixes (qmk#7758)
  Add Turkish keymap aliases and sendstring LUT (qmk#7676)
  Add Arm Teensys to mcu_selection.mk (qmk#8026)
  [New keyboard]silverbullet44 (qmk#7950)
  Allow 30us matrix delay to be keyboard/user overridable  (qmk#8216)
  Merge /prime_l and /prime_l_v2 (qmk#8194)
  [Keymap] Keymap for XD75 with 7U spacebar EN-RU gamers (qmk#8184)
  Add VIA support for kbd8x mk2 (qmk#8168)
  Move Grave/Tilde and some lesser used keys on my ergo boards (qmk#8200)
  [Keyboard] KC60SE cleanup (qmk#8171)
  Made windows driver installation accept y as All to allow CI (qmk#8189)
  Change the image photo of /keyboards/reviung41/readme.md (qmk#8195)
  MxSS RGB Handler Touchup (qmk#8105)
  Centromere Configurator layout support and readme update (qmk#8190)
  dynamic keymap sanity check (qmk#8181)
  [keyboard] Austin (qmk#8176)
  ...
c0psrul3 pushed a commit to c0psrul3/qmk_firmware that referenced this pull request Mar 23, 2020
* Create readme.md

* Create keymap.c

* Create config.h

* Create rules.mk

* Create layers.json

* Update keyboards/xd75/keymaps/buzzlighter1/keymap.c

* Update keyboards/xd75/keymaps/buzzlighter1/keymap.c

* Delete layers.json
kylekuj pushed a commit to kylekuj/qmk_firmware that referenced this pull request Apr 21, 2020
* Create readme.md

* Create keymap.c

* Create config.h

* Create rules.mk

* Create layers.json

* Update keyboards/xd75/keymaps/buzzlighter1/keymap.c

* Update keyboards/xd75/keymaps/buzzlighter1/keymap.c

* Delete layers.json
jakeisnt pushed a commit to jakeisnt/qmk_firmware that referenced this pull request Aug 20, 2020
* Create readme.md

* Create keymap.c

* Create config.h

* Create rules.mk

* Create layers.json

* Update keyboards/xd75/keymaps/buzzlighter1/keymap.c

* Update keyboards/xd75/keymaps/buzzlighter1/keymap.c

* Delete layers.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants