mirror of
https://github.com/qmk/qmk_userspace.git
synced 2025-06-17 02:57:55 -04:00
Compare commits
No commits in common. "main" and "latest" have entirely different histories.
7 changed files with 6 additions and 88 deletions
2
.clangd
2
.clangd
|
@ -1,4 +1,4 @@
|
||||||
CompileFlags:
|
CompileFlags:
|
||||||
Add: [-Wno-unknown-attributes, -Wno-maybe-uninitialized, -Wno-unknown-warning-option]
|
Add: [-Wno-unknown-attributes, -Wno-maybe-uninitialized, -Wno-unknown-warning-option]
|
||||||
Remove: [-W*, -mmcu=*, -mcpu=*, -mfpu=*, -mfloat-abi=*, -mno-unaligned-access, -mno-thumb-interwork, -mcall-prologues, -D__has_include*]
|
Remove: [-W*, -mcall-prologues]
|
||||||
Compiler: clang
|
Compiler: clang
|
||||||
|
|
|
@ -1,33 +0,0 @@
|
||||||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
|
||||||
// README at: https://github.com/devcontainers/templates/tree/main/src/debian
|
|
||||||
{
|
|
||||||
"name": "QMK CLI",
|
|
||||||
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
|
|
||||||
"image": "ghcr.io/qmk/qmk_cli",
|
|
||||||
"customizations": {
|
|
||||||
"vscode": {
|
|
||||||
"extensions": [
|
|
||||||
"amodio.toggle-excluded-files",
|
|
||||||
"EditorConfig.EditorConfig",
|
|
||||||
"xaver.clang-format",
|
|
||||||
"llvm-vs-code-extensions.vscode-clangd",
|
|
||||||
"bierner.github-markdown-preview",
|
|
||||||
"donjayamanne.git-extension-pack",
|
|
||||||
"ms-vscode-remote.remote-containers"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"postCreateCommand": "${containerWorkspaceFolder}/.devcontainer/setup.sh ${containerWorkspaceFolder}"
|
|
||||||
|
|
||||||
// Features to add to the dev container. More info: https://containers.dev/features.
|
|
||||||
// "features": {},
|
|
||||||
|
|
||||||
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
|
||||||
// "forwardPorts": [],
|
|
||||||
|
|
||||||
// Configure tool-specific properties.
|
|
||||||
// "customizations": {},
|
|
||||||
|
|
||||||
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
|
|
||||||
// "remoteUser": "root"
|
|
||||||
}
|
|
|
@ -1,23 +0,0 @@
|
||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
set -eEuo pipefail
|
|
||||||
|
|
||||||
wget https://bootstrap.pypa.io/get-pip.py
|
|
||||||
python3 get-pip.py
|
|
||||||
python3 -m pip install qmk
|
|
||||||
rm get-pip.py
|
|
||||||
|
|
||||||
python3 -m pip install --upgrade milc
|
|
||||||
|
|
||||||
userspacePath="$1"
|
|
||||||
|
|
||||||
git config --global --add safe.directory "$userspacePath"
|
|
||||||
git submodule update --init --recursive
|
|
||||||
|
|
||||||
[ -d /workspaces/qmk_firmware ] || git clone https://github.com/qmk/qmk_firmware.git /workspaces/qmk_firmware
|
|
||||||
git config --global --add safe.directory /workspaces/qmk_firmware
|
|
||||||
|
|
||||||
qmk config user.qmk_home=/workspaces/qmk_firmware
|
|
||||||
qmk config user.overlay_dir="$userspacePath"
|
|
||||||
|
|
||||||
qmk git-submodule
|
|
4
.github/workflows/build_binaries.yaml
vendored
4
.github/workflows/build_binaries.yaml
vendored
|
@ -8,13 +8,13 @@ permissions:
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
name: 'QMK Userspace Build'
|
name: 'QMK Userspace Build'
|
||||||
uses: qmk/.github/.github/workflows/qmk_userspace_build.yml@main
|
uses: qmk/.github/.github/workflows/qmk_userspace_build.yml@qmk-userspace
|
||||||
with:
|
with:
|
||||||
qmk_repo: qmk/qmk_firmware
|
qmk_repo: qmk/qmk_firmware
|
||||||
qmk_ref: master
|
qmk_ref: master
|
||||||
|
|
||||||
publish:
|
publish:
|
||||||
name: 'QMK Userspace Publish'
|
name: 'QMK Userspace Publish'
|
||||||
uses: qmk/.github/.github/workflows/qmk_userspace_publish.yml@main
|
uses: qmk/.github/.github/workflows/qmk_userspace_publish.yml@qmk-userspace
|
||||||
if: always() && !cancelled()
|
if: always() && !cancelled()
|
||||||
needs: build
|
needs: build
|
||||||
|
|
13
.gitignore
vendored
13
.gitignore
vendored
|
@ -1,16 +1,3 @@
|
||||||
# Junk files
|
|
||||||
*.bak
|
|
||||||
*.swp
|
|
||||||
*~
|
|
||||||
.DS_Store
|
|
||||||
._*
|
|
||||||
|
|
||||||
# Firmware files
|
|
||||||
*.hex
|
*.hex
|
||||||
*.bin
|
*.bin
|
||||||
*.uf2
|
*.uf2
|
||||||
|
|
||||||
# clangd
|
|
||||||
compile_commands.json
|
|
||||||
.clangd/
|
|
||||||
.cache/
|
|
||||||
|
|
12
.vscode/extensions.json
vendored
12
.vscode/extensions.json
vendored
|
@ -1,12 +0,0 @@
|
||||||
// Suggested extensions
|
|
||||||
{
|
|
||||||
"recommendations": [
|
|
||||||
"amodio.toggle-excluded-files",
|
|
||||||
"EditorConfig.EditorConfig",
|
|
||||||
"xaver.clang-format",
|
|
||||||
"llvm-vs-code-extensions.vscode-clangd",
|
|
||||||
"bierner.github-markdown-preview",
|
|
||||||
"donjayamanne.git-extension-pack",
|
|
||||||
"ms-vscode-remote.remote-containers"
|
|
||||||
]
|
|
||||||
}
|
|
|
@ -7,7 +7,6 @@ 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. 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. Fork this repository
|
||||||
1. Clone your fork to your local machine
|
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`
|
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>`
|
* 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>`
|
* You can also create a new keymap using `qmk new-keymap -kb <your_keyboard> -km <your_keymap>`
|
||||||
|
@ -16,7 +15,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>`
|
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
|
* This will automatically update your `qmk.json` file
|
||||||
* Corresponding `qmk userspace-remove -kb <your_keyboard> -km <your_keymap>` will delete it
|
* Corresponding `qmk userspace-remove -kb <your_keyboard> -km <your_keymap>` will delete it
|
||||||
* Listing the build targets can be done with `qmk userspace-list`
|
* Listing the build targets can be done with with `qmk userspace-list`
|
||||||
1. Commit your changes
|
1. Commit your changes
|
||||||
|
|
||||||
## Howto build with GitHub
|
## Howto build with GitHub
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue