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 a7ecf07 + 7d381fa commit 4f919be
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
2 changes: 2 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,5 @@ LEBASTARD

Alli # keeps getting detected as a word in youtube video id in embed
upstreaming
userspace
realpath
4 changes: 2 additions & 2 deletions _includes/use_keyboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ For customizing your keyboard, you can:

## Using VIA

All Bastard Keyboards come flashed with VIA. VIA is an additional layer that comes on top of QMK, and comes with a handy graphical interface. While it's limited in features, it removes the need to manage a git repository, the console and a QMK installation.
All Bastard Keyboards come flashed with a VIA-enabled firmware. VIA is an additional layer that comes on top of QMK, and comes with a handy graphical interface. While it's limited in features, it removes the need to manage a git repository, the console and a QMK installation.

You can open the [VIA Web Interface through use.via.app](https://usevia.app/). At the moment, only WebHID-enabled browsers work (eg. Chrome and Chromium-based).
You can open the [VIA Web Interface through usevia.app](https://usevia.app/). At the moment, only WebHID-enabled browsers work (eg. Chrome and Chromium-based).

Check warning on line 31 in _includes/use_keyboard.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (usevia)

You can check the following tutorial on how to use it:
{% include youtube.html id="cYICAlliJfU" %}
Expand Down
2 changes: 1 addition & 1 deletion _includes/use_keyboard_chary.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ For customizing your keyboard, you can:

All Bastard Keyboards come flashed with VIA. VIA is an additional layer that comes on top of QMK, and comes with a handy graphical interface. While it's limited in features, it removes the need to manage a git repository, the console and a QMK installation.

You can open the [VIA Web Interface through use.via.app](https://usevia.app/). At the moment, only WebHID-enabled browsers work (eg. Chrome and Chromium-based).
You can open the [VIA Web Interface through usevia.app](https://usevia.app/). At the moment, only WebHID-enabled browsers work (eg. Chrome and Chromium-based).

Check warning on line 53 in _includes/use_keyboard_chary.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (usevia)

You can check the following tutorial on how to use it:
{% include youtube.html id="cYICAlliJfU" %}
Expand Down
8 changes: 4 additions & 4 deletions fw/compile-firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) conta

While that repository is used as primary source of truth for Bastard Keyboards firmwares as it contains the latest changes and improvements, the maintainers aim at upstreaming all those changes to the official [QMK repository](https://github.com/qmk/qmk_firmware).

While the behavioural code is stored on the QMK repository, the keymaps are stored in our [QMK userspace](https://github.com/Bastardkb/qmk_userspace).
While the behavioral code is stored on the QMK repository, the keymaps are stored in our [QMK userspace](https://github.com/Bastardkb/qmk_userspace).

This page details how to compile your own firmware. Building from source is useful to people who want to customize their keyboard and keymaps beyond what Via offers. This involves using a command-line interface, writing C code, and compiling this code into the final firmware file.

Expand All @@ -35,7 +35,7 @@ Clone the BKB QMK repository, using either github desktop or the command line, a
```shell
git clone https://github.com/bastardkb/bastardkb-qmk
cd bastardkb-qmk
git checkout origin/bkb-master
git checkout -b bkb-master origin/bkb-master
```

Now that you've cloned the repository, `cd` into it and set it as the default local QMK repository. You also need to do this if you had a previous, separate QMK installation.
Expand Down Expand Up @@ -80,7 +80,7 @@ actions tab -- "I understand my workflows, go ahead and enable them"

# Compiling with console

Once in the QMK Userspace repository, compiling a keymap works the same as normal:
Once in the QMK userspace repository, compiling a keymap works the same as normal:

```shell
qmk compile -c -kb bastardkb/{keyboard} -km {keymap}
Expand Down Expand Up @@ -111,7 +111,7 @@ qmk compile -c -kb {keyboard} -km default -e VIA_ENABLE=yes

# Compiling with Github Actions

If you clone the BastardKB Userspace repository, it is alredy configured to work with the BastardKB QMK fork.
If you clone the BastardKB userspace repository, it is already configured to work with the BastardKB QMK fork.

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:

Check warning on line 116 in fw/compile-firmware.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (keympaps)

Expand Down

0 comments on commit 4f919be

Please sign in to comment.