diff --git a/.clangd b/.clangd index 2be2d817..6133ae72 100644 --- a/.clangd +++ b/.clangd @@ -1,4 +1,4 @@ CompileFlags: Add: [-Wno-unknown-attributes, -Wno-maybe-uninitialized, -Wno-unknown-warning-option] - Remove: [-W*, -mcall-prologues] + Remove: [-W*, -mmcu=*, -mcpu=*, -mfpu=*, -mfloat-abi=*, -mno-unaligned-access, -mno-thumb-interwork, -mcall-prologues] Compiler: clang diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 2b7b817a..7aaee1fd 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -17,7 +17,7 @@ ] } }, - "postCreateCommand": "/workspaces/qmk_userspace/.devcontainer/setup.sh" + "postCreateCommand": "${containerWorkspaceFolder}/.devcontainer/setup.sh ${containerWorkspaceFolder}" // Features to add to the dev container. More info: https://containers.dev/features. // "features": {}, diff --git a/.devcontainer/setup.sh b/.devcontainer/setup.sh index 25c7c5ee..9155c6cc 100755 --- a/.devcontainer/setup.sh +++ b/.devcontainer/setup.sh @@ -9,13 +9,15 @@ rm get-pip.py python3 -m pip install --upgrade milc -git config --global --add safe.directory /workspaces/qmk_userspace +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=/workspaces/qmk_userspace +qmk config user.overlay_dir="$userspacePath" qmk git-submodule diff --git a/.gitignore b/.gitignore index ec5cfa2b..800a4e2c 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,8 @@ *.hex *.bin *.uf2 + +# clangd +compile_commands.json +.clangd/ +.cache/ diff --git a/README.md b/README.md index 72b7d82c..25208997 100644 --- a/README.md +++ b/README.md @@ -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/` * You can also create a new keymap using `qmk new-keymap -kb -km ` @@ -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 -km ` * This will automatically update your `qmk.json` file * Corresponding `qmk userspace-remove -kb -km ` 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 @@ -55,4 +56,4 @@ This can also be used to control which fork is used, though only upstream `qmk_f 1. (First time only) `git submodule add https://github.com/qmk/qmk_firmware.git` 1. (To update) `git submodule update --init --recursive` -1. Commit your changes to your userspace repository \ No newline at end of file +1. Commit your changes to your userspace repository