From 4ed346a15451c1aa67e2181c5b7f578124568775 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 19:49:19 +0200 Subject: [PATCH 1/5] Update .wordlist.txt Co-authored-by: burkfers --- .wordlist.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.wordlist.txt b/.wordlist.txt index c06f888..bd0a46a 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -99,3 +99,4 @@ Alli # keeps getting detected as a word in youtube video id in embed upstreaming userspace realpath +usevia # keeps being detected in the url From 4f0fa678334e3d428f8ed3616efa2f2a4561d9fe Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 19:49:28 +0200 Subject: [PATCH 2/5] Update fw/compile-firmware.md Co-authored-by: burkfers --- fw/compile-firmware.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index 6d8f958..4352787 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -103,7 +103,7 @@ First, make sure you have went through the [Github actions requirements section After cloning the BastardKB userspace repository, it is already configured to work with the BastardKB QMK fork - so no need for additional configuration on that side. -If you created your own keymap, you will need to add it to the list of keympaps to be compiled in `qmk.json`, for example: +If you created your own keymap, you will need to add it to the list of keymaps to be compiled in `qmk.json`, for example: ```shell { From 1df7817e8eb25543793387674d6062ea934bb81d Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 19:49:34 +0200 Subject: [PATCH 3/5] Update fw/compile-firmware.md Co-authored-by: burkfers --- fw/compile-firmware.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index 4352787..90bb02a 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -48,7 +48,7 @@ qmk config user.qmk_home="$(realpath .)" If you have multiple QMK installations, you will need to manually set the qmk home path again to use the other ones. That's all you needed to do with the QMK repository. -From here on, **we will only focus on the Userspace repository.** +From here on, **we will only focus on the userspace repository.** ## BastardKb userspace From e97035a5b29d5bece294313a2dc57a9903ca049d Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 19:49:40 +0200 Subject: [PATCH 4/5] Update fw/compile-firmware.md Co-authored-by: burkfers --- fw/compile-firmware.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index 90bb02a..967e444 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -72,7 +72,7 @@ qmk config user.overlay_dir="$(realpath .)" ## Github actions {#actions-requirements} -If you want to use Github actions to compile your firmware (rather than the console), you will need to: +If you want to use Github actions to compile your firmware (rather than doing it locally in the console), you will need to: - fork the BastardKB QMK Userspace repository - in the `Actions` tab, enable workflows From 64c28b040b710b26a99625099c3e0f65346b5abf Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 19:50:02 +0200 Subject: [PATCH 5/5] Update fw/compile-firmware.md Co-authored-by: burkfers --- fw/compile-firmware.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index 967e444..aea221b 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -124,7 +124,7 @@ Then, 1. Inspect the Releases tab on your repository for the latest firmware build -# Compiling with console +# Compiling locally Once in the QMK userspace repository, compiling a keymap works the same as normal: