diff --git a/.wordlist.txt b/.wordlist.txt index 4314ef9..c06f888 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -97,3 +97,5 @@ LEBASTARD Alli # keeps getting detected as a word in youtube video id in embed upstreaming +userspace +realpath diff --git a/_includes/use_keyboard.md b/_includes/use_keyboard.md index f1438f8..2e04d08 100644 --- a/_includes/use_keyboard.md +++ b/_includes/use_keyboard.md @@ -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). You can check the following tutorial on how to use it: {% include youtube.html id="cYICAlliJfU" %} diff --git a/_includes/use_keyboard_chary.md b/_includes/use_keyboard_chary.md index 64539d2..9ddf855 100644 --- a/_includes/use_keyboard_chary.md +++ b/_includes/use_keyboard_chary.md @@ -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). You can check the following tutorial on how to use it: {% include youtube.html id="cYICAlliJfU" %} diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index 40d2208..baba144 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -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. @@ -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. @@ -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} @@ -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: