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

Adding support for Xlant XL keyboard #24608

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

Adding support for Xlant XL keyboard #24608

wants to merge 30 commits into from
+157 −0

Conversation

ChrisGVE
Copy link
Contributor

@ChrisGVE ChrisGVE commented Nov 16, 2024 •
edited
Loading

The change includes the keyboard layout, data driven with .json file, and a default layout as a starting point to customize a board.

Description

The change include a new main folder zlant_xl for a single keyboard.

The keyboard is fully configured via a keyboard.json file. In addition a default layout is provided.

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

  • n/a

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

ChrisGVE and others added 23 commits November 5, 2024 15:55
@ChrisGVE
Added a default firmware and layout for the WindStudio Wind X R1
e1db7e4 
keyboard.
@ChrisGVE
Wind X R1: cleaned-up the folders to make clear that this firmware is
084a28b 
for the release 1 of this keyboard.
@ChrisGVE
Added rules.mk to the default layout
cc9b828
@ChrisGVE
Renamed the folder R1 into r1.
91a48c4
@ChrisGVE
Added readme.md files for the keyboard and default layout.
550673a
@ChrisGVE
Added a license header to keymap.c
1b84283
@ChrisGVE @waffle87
Update keyboards/windstudio/wind_x/r1/keyboard.json
0d7d756 
Co-authored-by: jack <[email protected]>
@ChrisGVE @waffle87
Update keyboards/windstudio/wind_x/r1/keyboard.json
8a9530a 
Co-authored-by: jack <[email protected]>
@ChrisGVE @waffle87
Update keyboards/windstudio/wind_x/r1/keymaps/default/keymap.c
c94912d 
Co-authored-by: jack <[email protected]>
@ChrisGVE @waffle87
Update keyboards/windstudio/wind_x/r1/readme.md
9c7271f 
Co-authored-by: jack <[email protected]>
@ChrisGVE
Added a proper link to the image (logo of windstudio)
115bd7b
@ChrisGVE
Wind X R1
1dbe38d 
- Corrected the default keymap with the QK_GESC key instead of the
  KC_ESC.
- Removed the unnecessary rules.mk in the default layout
@ChrisGVE
Wind X R1:
7a9a6c7 
applied `qmk format-json -i` on keyboard.json to conform with the
project formatt standards.
@ChrisGVE
Cleaning this branch to keep only the zlant_xl files.
6d06fdc
@ChrisGVE
Merge branch 'qmk:master' into zlant_xl
ea62d2e
@ChrisGVE
Added the Zlant_XL keyboard (legacy)
88691e9
@ChrisGVE
zlant_xl:
c00d849 
Reconfigured the keyboard now fully data driven.
TODO: add support for RGB lighting
@ChrisGVE
ADDED:
6df80c2 
keyboard.json for Xlant XL
@ChrisGVE
Merge branch 'qmk:master' into zlant_xl
2994f91
@ChrisGVE
docs(zlant_xl): add readme.md, updated keymap.c with correct year
d29b667
@ChrisGVE
fix(zlant_xl): fixed a wrong link in readme.md
b448690
@ChrisGVE
docs(zlant_xl): update readme with correct position of the reset button.
f381765
@ChrisGVE
chore(zlant_xl): run qmk format-json on keyboard.json
689e117
@ChrisGVE ChrisGVE changed the title Adding support for Windstudio's Xlant XL keyboard Adding support for Xlant XL keyboard Nov 16, 2024
waffle87
waffle87 requested changes Nov 16, 2024
View reviewed changes
Copy link
Member

@waffle87 waffle87 left a comment

Choose a reason for hiding this comment

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

If this keyboard is made/sold by 1upkeyboards, it should probably live with the rest of the keyboards under keyboards/1upkeyboards/....

keyboards/zlant_xl/keymaps/default/keymap.c Outdated Show resolved Hide resolved
keyboards/zlant_xl/keymaps/default/keymap.c Outdated Show resolved Hide resolved
keyboards/zlant_xl/readme.md Outdated Show resolved Hide resolved
keyboards/zlant_xl/readme.md Show resolved Hide resolved
@ChrisGVE
Copy link
Contributor Author

Regarding the 1UpKeyboards folder, I noted that they sell the Zlant keyboard (https://1upkeyboards.com/shop/keyboard-kits/diy-40-kits/zlant-40-keyboard-pcb/), which lives in QMK in the main keyboards folder. That's why I kept the Zlant XL at the same level.
What is your suggestion?

@waffle87
Copy link
Member

Ah, I suppose it looks like the ZlantXL was designed/sold outside of 1upkeyboards originally (Reddit post). So I suppose its current location is more appropriate.

@waffle87 waffle87 requested a review from a team November 16, 2024 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@waffle87 waffle87 waffle87 approved these changes

@fauxpark fauxpark fauxpark approved these changes

Assignees
No one assigned
Labels
keyboard keymap
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ChrisGVE @waffle87 @fauxpark