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

qmk setup will not accept my Github Username because it has a hyphen in it. #24700

Closed
Orphan-Crippler opened this issue Dec 10, 2024 · 4 comments

Comments

@Orphan-Crippler
Copy link

Issue Description

Just like the title says, when I am trying to make a new keymap qmk is will not let me use my github username because there is a hyphen in it.

@waffle87
Copy link
Member

This is not an "issue", the error you're present with:

☒ Keymap names must contain only a-z, 0-9 and _! Please choose a different name.

Is simply a requirement of the build system. You must choose a keymap name that does not have a hyphen in it.

The keymap name does not need to match your Github username nor does it have any affect what you choose to name it, so long as it follows the expected regex.

@Orphan-Crippler
Copy link
Author

Thank you, I thought it was asking for my GitHub username. It is a little misleading as the last thing it displays is asking about that. Maybe this could be changed to something better?

❯ qmk new-keymap -kb crkbd
Ψ Generating a new keymap

Name Your Keymap
Used for maintainer, copyright, etc

Your GitHub Username? [Orphan-Crippler]

@waffle87
Copy link
Member

Hopefully a bit clearer in #24701.

@Orphan-Crippler
Copy link
Author

Yea, that's definitely better!

Thank You!

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

No branches or pull requests

2 participants