Merge pull request #17 from lejouson/main

Sync fork changes into keymap branch
This commit is contained in:
Jose Gisbert 2025-02-03 16:57:21 +01:00 committed by GitHub
commit 76a5b6905b
Failed to generate hash of commit
2 changed files with 8 additions and 2 deletions

5
.gitignore vendored
View file

@ -9,3 +9,8 @@
*.hex
*.bin
*.uf2
# clangd
compile_commands.json
.clangd/
.cache/

View file

@ -7,6 +7,7 @@ This is a template repository which allows for an external set of QMK keymaps to
1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
1. Fork this repository
1. Clone your fork to your local machine
1. Enable userspace in QMK config using `qmk config user.overlay_dir="$(realpath qmk_userspace)"`
1. Add a new keymap for your board using `qmk new-keymap`
* This will create a new keymap in the `keyboards` directory, in the same location that would normally be used in the main QMK repository. For example, if you wanted to add a keymap for the Planck, it will be created in `keyboards/planck/keymaps/<your keymap name>`
* You can also create a new keymap using `qmk new-keymap -kb <your_keyboard> -km <your_keymap>`
@ -15,7 +16,7 @@ This is a template repository which allows for an external set of QMK keymaps to
1. Add your keymap(s) to the build by running `qmk userspace-add -kb <your_keyboard> -km <your_keymap>`
* This will automatically update your `qmk.json` file
* Corresponding `qmk userspace-remove -kb <your_keyboard> -km <your_keymap>` will delete it
* Listing the build targets can be done with with `qmk userspace-list`
* Listing the build targets can be done with `qmk userspace-list`
1. Commit your changes
## Howto build with GitHub