https://github.com/hugginsio/qmk_userspace
Personal QMK external userspace.
https://github.com/hugginsio/qmk_userspace
Last synced: 7 months ago
JSON representation
Personal QMK external userspace.
- Host: GitHub
- URL: https://github.com/hugginsio/qmk_userspace
- Owner: hugginsio
- License: gpl-2.0
- Created: 2024-01-06T04:54:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-06T19:36:45.000Z (almost 2 years ago)
- Last Synced: 2025-01-29T22:46:19.808Z (9 months ago)
- Language: C
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QMK Userspace
An [external QMK userspace][external-userspace] for maintaining my own keymaps and configuration files outside the main firmware repository.
## Compiling
Compile the firmware for a particular keyboard and keymap:
```shell
qmk compile -kb -km
```
Compile all build targets, as defined in [`qmk.json`](./qmk.json):
```shell
qmk userspace-compile
```
## Management
Create a new keymap and add it to the build targets file:
```shell
qmk userspace-add -kb -km
```
Remove a keymap:
```shell
qmk userspace-remove -kb -km
```
Convert a C keymap to Configurator JSON:
```shell
qmk c2json -kb -km
```
Convert Configurator export to a C keymap:
```shell
qmk json2c
```
## Related
- [`filterpaper/qmk_userspace`][filterpaper-userspace]
- [`qmk/qmk_userspace`][qmk-userspace]
[external-userspace]: https://docs.qmk.fm/#/newbs_external_userspace
[filterpaper-userspace]: https://github.com/filterpaper/qmk_userspace
[qmk-userspace]: https://github.com/qmk/qmk_userspace