Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
bstiq committed Aug 2, 2024
2 parents 423a814 + 64c28b0 commit c8d3449
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,4 @@ Alli # keeps getting detected as a word in youtube video id in embed
upstreaming
userspace
realpath
usevia # keeps being detected in the url
8 changes: 4 additions & 4 deletions fw/compile-firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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
{
Expand All @@ -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:

Expand Down

0 comments on commit c8d3449

Please sign in to comment.