From 65f72d7112e4dec5132988ef930bba1e398a9221 Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 1 Aug 2024 16:51:40 +0200 Subject: [PATCH 01/49] separate daily use and customize --- _includes/use_keyboard.md | 55 +++++++++++++++ ...mize_keyboard.md => use_keyboard_chary.md} | 18 +++-- bg_charybdis/13customize.md | 4 +- bg_cnano/13customize.md | 4 +- bg_scylla/13customize.md | 4 +- bg_skeletyl/13customize.md | 4 +- fw/compile-firmware.md | 69 +++++++++++++++++++ fw/flashing.md | 4 +- 8 files changed, 148 insertions(+), 14 deletions(-) create mode 100644 _includes/use_keyboard.md rename _includes/{customize_keyboard.md => use_keyboard_chary.md} (71%) create mode 100644 fw/compile-firmware.md diff --git a/_includes/use_keyboard.md b/_includes/use_keyboard.md new file mode 100644 index 0000000..8fae33b --- /dev/null +++ b/_includes/use_keyboard.md @@ -0,0 +1,55 @@ +# Table of contents + +1. TOC +{:toc} + +# Introduction + +Congratulations on successfully building your keyboard! + +The Bastard Keyboards come with a range of features, and it's also easy to customize them. On this page you will find additional information on how to use them and make them your own. + +# Daily use + +## Default keymap + +You can find pictures of the default keymaps on the [default keymaps page][keymaps]. + +Alternatively, you can also plug in your keyboard and visualize the keymap using VIA (see VIA section). + +## Miryoku + +The 3x5 keyboards (Skeletyl, Charybdis Nano) come flashed with [Miryoku](https://github.com/manna-harbour/miryoku). On its github repository you will find useful information on the different layers available. + +# Customization + +For customizing your keyboard, you can: + +- use VIA +- use QMK + +## 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. + +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 check the following tutorial on how to use it: +{% include youtube.html id="cYICAlliJfU" %} + +Through VIA, you can customize: +- the keymap +- macros, layers +- RGB + +## Using QMK + +This is for advanced users. + +For how to compile a custom hardware for your keyboard, take a look at the [how to compile your own firmware page][compile-firmware]. + +--- + +[compile-firmware]: {{site.baseurl}}/fw/compile-firmware.html +[keymaps]: {{site.baseurl}}/fw/default-keymaps.html +[flashing]: {{site.baseurl}}/fw/flashing.html \ No newline at end of file diff --git a/_includes/customize_keyboard.md b/_includes/use_keyboard_chary.md similarity index 71% rename from _includes/customize_keyboard.md rename to _includes/use_keyboard_chary.md index 2976ff7..b8ab04e 100644 --- a/_includes/customize_keyboard.md +++ b/_includes/use_keyboard_chary.md @@ -43,11 +43,19 @@ You can also configure qmk to have it activated automatically. The 3x5 keyboards (Skeletyl, Charybdis Nano) come flashed with [Miryoku](https://github.com/manna-harbour/miryoku). On its github repository you will find useful information on the different layers available. + # Customization +For customizing your keyboard, you can: + +- use VIA +- use QMK + ## Using VIA -All Bastard Keyboards come flashed with VIA. 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). +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 check the following tutorial on how to use it: {% include youtube.html id="cYICAlliJfU" %} @@ -59,14 +67,14 @@ Through VIA, you can customize: ## Using QMK -You can find the latest **default images** for all Bastard Keyboards in the release section of the [BastardKB QMK fork](https://github.com/Bastardkb/bastardkb-qmk/releases). +This is for advanced users. -For how to flash your keyboard, take a look at the [how to flash your keyboard page][flashing]. +For how to compile a custom hardware for your keyboard, take a look at the [how to compilee your own firmware page][compile-firmware]. -For **advanced customization of the Charybdis and Charybdis Nano**, take a look at the [customize page][customize]. +For **advanced customization of the Charybdis and Charybdis Nano**, take a look at the [customize page][customize-chary]. --- -[customize]: {{site.baseurl}}/fw/charybdis-features.html +[customize-chary]: {{site.baseurl}}/fw/charybdis-features.html [keymaps]: {{site.baseurl}}/fw/default-keymaps.html [flashing]: {{site.baseurl}}/fw/flashing.html \ No newline at end of file diff --git a/bg_charybdis/13customize.md b/bg_charybdis/13customize.md index 7fb2ec4..fa5ad47 100644 --- a/bg_charybdis/13customize.md +++ b/bg_charybdis/13customize.md @@ -1,9 +1,9 @@ --- layout: default -title: Customizing your keyboard +title: Using your keyboard nav_order: 13 parent: Build guide - Charybdis --- -{% include customize_keyboard.md %} \ No newline at end of file +{% include use_keyboard_chary.md %} \ No newline at end of file diff --git a/bg_cnano/13customize.md b/bg_cnano/13customize.md index e50526e..d225d3a 100644 --- a/bg_cnano/13customize.md +++ b/bg_cnano/13customize.md @@ -1,9 +1,9 @@ --- layout: default -title: Customizing your keyboard +title: Using your keyboard nav_order: 13 parent: Build guide - Charybdis Nano --- -{% include customize_keyboard.md %} \ No newline at end of file +{% include use_keyboard_chary.md %} \ No newline at end of file diff --git a/bg_scylla/13customize.md b/bg_scylla/13customize.md index d13928f..2acd04f 100644 --- a/bg_scylla/13customize.md +++ b/bg_scylla/13customize.md @@ -1,9 +1,9 @@ --- layout: default -title: Customizing your keyboard +title: Using your keyboard nav_order: 13 parent: Build guide - Scylla --- -{% include customize_keyboard.md %} \ No newline at end of file +{% include use_keyboard.md %} \ No newline at end of file diff --git a/bg_skeletyl/13customize.md b/bg_skeletyl/13customize.md index 7a3cf87..cd8ff65 100644 --- a/bg_skeletyl/13customize.md +++ b/bg_skeletyl/13customize.md @@ -1,9 +1,9 @@ --- layout: default -title: Customizing your keyboard +title: Using your keyboard nav_order: 13 parent: Build guide - Skeletyl --- -{% include customize_keyboard.md %} \ No newline at end of file +{% include use_keyboard.md %} \ No newline at end of file diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md new file mode 100644 index 0000000..cc22e96 --- /dev/null +++ b/fw/compile-firmware.md @@ -0,0 +1,69 @@ +--- +layout: default +title: Compiling your firmware +nav_order: 99 +parent: Firmware +--- + +# Table of contents + +1. TOC +{:toc} + + +# Introduction + +The [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) contains the firmware code and releases for the Bastard Keyboards Charybdis boards. + +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). + +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. + +If that seems too complicated, you can also use one of the default releases, or VIA. // TODO links + +# Requirements + +1. Follow the [QMK docs](https://docs.qmk.fm/#/getting_started_build_tools) to setup your environment +2. Checkout this repository + +# Building your firmware + +To build a firmware, use the `bkb-master` branch: + +```shell +git checkout origin/bkb-master +qmk compile -c -kb bastardkb/{keyboard} -km {keymap} +``` + +## `{keyboard}` argument + +`{keyboard}` corresponds to the physical keyboard you are building the firmware for. It can be one of the following: + +- `charybdis/4x6`: the 4x6+5 [Charybdis](https://github.com/bastardkb/charybdis/) +- `charybdis/3x5`: the 3x5+3 [Charybdis Nano](https://github.com/bastardkb/charybdis/) +- `charybdis/3x6`: the 3x6+3 [Charybdis Mini](https://github.com/bastardkb/charybdis/) +- `scylla`: the 4x6+5 [Scylla](https://github.com/Bastardkb/Scylla) +- `skeletyl`: the 3x5+3 [Skeletyl](https://github.com/Bastardkb/Skeletyl/) +- `tbkmini`: the 3x6+3 [TBK Mini](https://github.com/Bastardkb/TBK-Mini/) +- `dilemma/3x5_3`: the 3x5+3 [Dilemma](https://github.com/bastardkb/dilemma/) +- `dilemma/4x6_4`: the 4x6+4 [Dilemma Max](https://github.com/bastardkb/dilemma/) + +## `{keymap}` argument + +All keyboards have a `default` keymap. Most also have a `via` keymap. The latter is already configured to work with [Via](https://usevia.app). + +To build *any* keymap with Via support, simply add the following argument to the command line: `-e VIA_ENABLE=yes`, e.g.: + +```shell +qmk compile -c -kb {keyboard} -km default -e VIA_ENABLE=yes +``` + +# Flashing your keyboard + +Once you compiled your `uf2` image, you can flash your keyboard. + +For how to flash your keyboard, take a look at the [how to flash your keyboard page][flashing]. + +--- + +[flashing]: {{site.baseurl}}/fw/flashing.html \ No newline at end of file diff --git a/fw/flashing.md b/fw/flashing.md index 17a4dec..c7ff664 100644 --- a/fw/flashing.md +++ b/fw/flashing.md @@ -34,6 +34,8 @@ To flash your new image, you will need to go through a few steps: Below is detailed the exact procedure to follow. You need to flash either the right side only, or the right and left side separately - this is also detailed below. +# Sourcing your firmware + Sourcing your firmware can be done in a couple ways: - downloading it from the [release section on github][releases] @@ -130,7 +132,7 @@ Unplug the USB connector and connect the other side, and then repeat the procedu If you use the `QK_BOOT` method, please note that your layout may now be mirrored! This is normal, ignore it and plug the USB back into the right side. ---- -[build]: https://github.com/Bastardkb/bastardkb-qmk?tab=readme-ov-file#building-from-source-advanced +[build]: {{site.baseurl}}/fw/compile-firmware.html [releases]: https://github.com/Bastardkb/bastardkb-qmk/releases [keymaps]: {{site.baseurl}}/fw/default-keymaps.html [splitkb-whentoflash]: https://docs.splitkb.com/hc/en-us/articles/360011949679-When-do-I-need-to-flash-my-microcontroller From b4cac0eab7967e4727b07e01cfa3dd42c9ddb66f Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 1 Aug 2024 17:06:36 +0200 Subject: [PATCH 02/49] clean up --- _includes/use_keyboard_chary.md | 2 +- bg_dilemma/customize.md | 9 +++++++++ bg_dilemma/intro.md | 2 ++ bg_dilemma/max_v1.md | 10 ---------- bg_dilemma/v1.md | 3 +-- bg_dilemma/v2.md | 6 ++++-- 6 files changed, 17 insertions(+), 15 deletions(-) create mode 100644 bg_dilemma/customize.md delete mode 100644 bg_dilemma/max_v1.md diff --git a/_includes/use_keyboard_chary.md b/_includes/use_keyboard_chary.md index b8ab04e..65370df 100644 --- a/_includes/use_keyboard_chary.md +++ b/_includes/use_keyboard_chary.md @@ -34,7 +34,7 @@ The most important ones are on the thumb cluster - it transforms into mouse butt ### Sniping -Sniping **slows down the trackball**. This way, you can move the cursor more precisely. +Sniping **slows down the trackball/trackpad**. This way, you can move the cursor more precisely. By default, Sniping mode is activated when you hold the `MOUSE + SNIP` keys at the same time. You can also configure qmk to have it activated automatically. diff --git a/bg_dilemma/customize.md b/bg_dilemma/customize.md new file mode 100644 index 0000000..28bf41b --- /dev/null +++ b/bg_dilemma/customize.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Using your Dilemma +nav_order: 99 +parent: Build guide - Dilemma +--- + + +{% include use_keyboard_chary.md %} \ No newline at end of file diff --git a/bg_dilemma/intro.md b/bg_dilemma/intro.md index 753c510..32369c7 100644 --- a/bg_dilemma/intro.md +++ b/bg_dilemma/intro.md @@ -11,5 +11,7 @@ We recommend you start by reading the *required tools* section. There are written guides, and there are also video guides in the *video guides* section. +For building the Dilemma MAX, just follow the Dilemma instructions - it's the same keyboard, just bigger. + 1. TOC {:toc} diff --git a/bg_dilemma/max_v1.md b/bg_dilemma/max_v1.md deleted file mode 100644 index bc5490e..0000000 --- a/bg_dilemma/max_v1.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -layout: default -title: MAX build guide -nav_order: 7 -parent: Build guide - Dilemma ---- - -1. TOC -{:toc} - diff --git a/bg_dilemma/v1.md b/bg_dilemma/v1.md index cdbeccf..5289e79 100644 --- a/bg_dilemma/v1.md +++ b/bg_dilemma/v1.md @@ -108,6 +108,5 @@ Solder in your switches of preference. You're all done! -Head over to [bstkbd.com/custom](https://bstkbd.com/custom) to customize your keyboard to your needs. +Head over to [Customize your Dilemma firmware][use-dilemma] to customize your keyboard to your needs. -If you need any help with it, make sure to hop on the discord : [bstkbd.com/discord](https://www.bstkbd.com/discord) diff --git a/bg_dilemma/v2.md b/bg_dilemma/v2.md index 42fd162..c249501 100644 --- a/bg_dilemma/v2.md +++ b/bg_dilemma/v2.md @@ -120,6 +120,8 @@ Solder in your switches of preference. You're all done! -Head over to [bstkbd.com/custom](https://bstkbd.com/custom) to customize your keyboard to your needs. +Head over to [Customize your Dilemma firmware][use-dilemma] to customize your keyboard to your needs. -If you need any help with it, make sure to hop on the discord : [bstkbd.com/discord](https://www.bstkbd.com/discord) +--- + +[use-dilemma]: {{site.baseurl}}/bg_dilemma/customize.html \ No newline at end of file From 1d1170bc3ee2b524817461aa66ba57e24f25cd90 Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 1 Aug 2024 17:14:51 +0200 Subject: [PATCH 03/49] missing link --- _includes/use_keyboard_chary.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_includes/use_keyboard_chary.md b/_includes/use_keyboard_chary.md index 65370df..bfa7526 100644 --- a/_includes/use_keyboard_chary.md +++ b/_includes/use_keyboard_chary.md @@ -77,4 +77,5 @@ For **advanced customization of the Charybdis and Charybdis Nano**, take a look [customize-chary]: {{site.baseurl}}/fw/charybdis-features.html [keymaps]: {{site.baseurl}}/fw/default-keymaps.html -[flashing]: {{site.baseurl}}/fw/flashing.html \ No newline at end of file +[flashing]: {{site.baseurl}}/fw/flashing.html +[compile-firmware]: {{site.baseurl}}/fw/compile-firmware.html \ No newline at end of file From 4f4e029492788764bb56dd4a609030e81d989195 Mon Sep 17 00:00:00 2001 From: burkfers Date: Thu, 1 Aug 2024 17:31:10 +0200 Subject: [PATCH 04/49] expand wordlist --- .wordlist.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.wordlist.txt b/.wordlist.txt index 248f272..432ab1f 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -94,3 +94,5 @@ udev Singel LEBASTARD + +Alli # keeps getting detected as a word in youtube video id in embed From 60db80d6f849a17ab1e428f8955022a2cbf19b8c Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 1 Aug 2024 17:41:56 +0200 Subject: [PATCH 05/49] Update _includes/use_keyboard_chary.md Co-authored-by: burkfers --- _includes/use_keyboard_chary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/use_keyboard_chary.md b/_includes/use_keyboard_chary.md index bfa7526..0cba2f7 100644 --- a/_includes/use_keyboard_chary.md +++ b/_includes/use_keyboard_chary.md @@ -69,7 +69,7 @@ Through VIA, you can customize: This is for advanced users. -For how to compile a custom hardware for your keyboard, take a look at the [how to compilee your own firmware page][compile-firmware]. +For how to compile a custom hardware for your keyboard, take a look at the [how to compile your own firmware page][compile-firmware]. For **advanced customization of the Charybdis and Charybdis Nano**, take a look at the [customize page][customize-chary]. From 0b7014fdab0948c59e889a6b5b7feadd3ea1c3ce Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 1 Aug 2024 17:42:01 +0200 Subject: [PATCH 06/49] Update .wordlist.txt Co-authored-by: burkfers --- .wordlist.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.wordlist.txt b/.wordlist.txt index 432ab1f..4314ef9 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -96,3 +96,4 @@ Singel LEBASTARD Alli # keeps getting detected as a word in youtube video id in embed +upstreaming From 01908d9ab5f71dc00e385f25485b6f2ba77a0ff6 Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 1 Aug 2024 21:11:40 +0200 Subject: [PATCH 07/49] Remove todo --- fw/compile-firmware.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index cc22e96..c77b823 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -19,7 +19,7 @@ While that repository is used as primary source of truth for Bastard Keyboards f 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. -If that seems too complicated, you can also use one of the default releases, or VIA. // TODO links +If that seems too complicated, you can also use one of the default releases, or VIA. # Requirements @@ -66,4 +66,4 @@ For how to flash your keyboard, take a look at the [how to flash your keyboard p --- -[flashing]: {{site.baseurl}}/fw/flashing.html \ No newline at end of file +[flashing]: {{site.baseurl}}/fw/flashing.html From 60e2ef66f0ef180e4d8bf52de7cd08215d92bc41 Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 1 Aug 2024 21:12:48 +0200 Subject: [PATCH 08/49] Update compile-firmware.md --- fw/compile-firmware.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index c77b823..5553241 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -23,8 +23,7 @@ If that seems too complicated, you can also use one of the default releases, or # Requirements -1. Follow the [QMK docs](https://docs.qmk.fm/#/getting_started_build_tools) to setup your environment -2. Checkout this repository +Follow the [QMK docs](https://docs.qmk.fm/#/getting_started_build_tools) to setup your environment # Building your firmware From cfc760a04ddf89c80145c358fb0632af6cc92259 Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 1 Aug 2024 21:13:59 +0200 Subject: [PATCH 09/49] Update compile-firmware.md --- fw/compile-firmware.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index 5553241..0af9934 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -23,7 +23,8 @@ If that seems too complicated, you can also use one of the default releases, or # Requirements -Follow the [QMK docs](https://docs.qmk.fm/#/getting_started_build_tools) to setup your environment +1. Follow the [QMK docs](https://docs.qmk.fm/#/getting_started_build_tools) to setup your environment +2. Clone the [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) # Building your firmware From 300e62a9fc13411c4d13c3393d18a917c6323658 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 14:34:39 +0200 Subject: [PATCH 10/49] add userspace info draft --- fw/compile-firmware.md | 92 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 85 insertions(+), 7 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index 0af9934..c06b1d1 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -10,7 +10,6 @@ parent: Firmware 1. TOC {:toc} - # Introduction The [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) contains the firmware code and releases for the Bastard Keyboards Charybdis boards. @@ -21,17 +20,70 @@ This page details how to compile your own firmware. Building from source is usef If that seems too complicated, you can also use one of the default releases, or VIA. -# Requirements +# Pre-requisites + +## Working QMK environment + +Make sure you have a functional QMK environment. See [QMK Docs](https://docs.qmk.fm/#/newbs) for details. At this point, **you don't need** to run `qmk setup`. -1. Follow the [QMK docs](https://docs.qmk.fm/#/getting_started_build_tools) to setup your environment -2. Clone the [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) +## BastardKb QMK fork -# Building your firmware +We maintain our own QMK fork. It serves as the primary source of truth, and contains the latest changes and innovation. +While we regularly push to the main QMK repository, the BKB QMK fork is the one that's most up to date. -To build a firmware, use the `bkb-master` branch: +Clone the BKB QMK repository, using either github desktop or the command line, and switch to the `bkb-master` branch: ```shell +git clone https://github.com/bastardkb/bastardkb-qmk git checkout 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. + +```shell +cd bastardkb-qmk +qmk config user.qmk_home="$(realpath .)" +``` + +{: .note } +If you have multiple QMK installations, you will need to manually set the qmk home path again to use the other ones. + +## BastardKb userspace + +While the QMK repository contains the logic behind the keyboards, the keymaps are in the userspace repository. + +In a separate folder, clone the BKB QMK repository, using either github desktop or the command line: + + +```shell +git clone https://github.com/bastardkb/qmk_userspace +``` + +Next, `cd` into the repository and enable userspace: + +```shell +cd qmk_userspace +qmk config user.overlay_dir="$(realpath .)" +``` + +## Github actions + +// TODO screenshot enable actions workflows + +// TODO mroe details, screenshots +actions tab -- "I understand my workflows, go ahead and enable them" + +1. In the GitHub Actions tab, enable workflows +2. Push your changes above to your forked GitHub repository +3. Look at the GitHub Actions for a new actions run +4. Wait for the actions run to complete +5. Inspect the Releases tab on your repository for the latest firmware build + +# Compiling with console + +Once in the QMK Userspace repository, compiling a keymap works the same as normal: + +```shell qmk compile -c -kb bastardkb/{keyboard} -km {keymap} ``` @@ -58,12 +110,38 @@ To build *any* keymap with Via support, simply add the following argument to the 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 created your own keymap, you will need to add it to the list of keympaps to be compiled in `qmk.json`, for example: + +```shell +{ + "userspace_version": "1.0", + "build_targets": [ + ["bastardkb/charybdis/4x6", "my-keymap"] + ] +} +``` + +We also recommend deleting the other keymaps if you don't use them, as it'll make the action run faster. + +# Creating your own keymap + +// TODO + +# Contributing your own keymap + +// TODO + # Flashing your keyboard Once you compiled your `uf2` image, you can flash your keyboard. For how to flash your keyboard, take a look at the [how to flash your keyboard page][flashing]. + --- -[flashing]: {{site.baseurl}}/fw/flashing.html +[flashing]: {{site.baseurl}}/fw/flashing.html \ No newline at end of file From 39655880b0393981cf2531e47449eed3db6179d1 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 14:36:58 +0200 Subject: [PATCH 11/49] Update compile-firmware.md --- fw/compile-firmware.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index c06b1d1..18b5a3d 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -16,6 +16,8 @@ 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). + 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. If that seems too complicated, you can also use one of the default releases, or VIA. @@ -28,9 +30,6 @@ Make sure you have a functional QMK environment. See [QMK Docs](https://docs.qmk ## BastardKb QMK fork -We maintain our own QMK fork. It serves as the primary source of truth, and contains the latest changes and innovation. -While we regularly push to the main QMK repository, the BKB QMK fork is the one that's most up to date. - Clone the BKB QMK repository, using either github desktop or the command line, and switch to the `bkb-master` branch: ```shell From 75e94be6ebcf9d69355262133ad85cdcd965fb90 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 14:37:43 +0200 Subject: [PATCH 12/49] Update compile-firmware.md --- 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 18b5a3d..09847dc 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -34,13 +34,13 @@ 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 ``` 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. ```shell -cd bastardkb-qmk qmk config user.qmk_home="$(realpath .)" ``` From 9de023e76b06bb2046b3cf6230ac35e8e21bd9d2 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 14:38:05 +0200 Subject: [PATCH 13/49] Update compile-firmware.md --- 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 09847dc..fdd398d 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -44,7 +44,7 @@ Now that you've cloned the repository, `cd` into it and set it as the default lo qmk config user.qmk_home="$(realpath .)" ``` -{: .note } +{: .info } If you have multiple QMK installations, you will need to manually set the qmk home path again to use the other ones. ## BastardKb userspace From 493873ad4e949f1182a69c6530e44a0ad6dca9b5 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:04:37 +0200 Subject: [PATCH 14/49] remove miryoku mentions --- _includes/use_keyboard.md | 4 ---- _includes/use_keyboard_chary.md | 5 ----- 2 files changed, 9 deletions(-) diff --git a/_includes/use_keyboard.md b/_includes/use_keyboard.md index 8fae33b..f1438f8 100644 --- a/_includes/use_keyboard.md +++ b/_includes/use_keyboard.md @@ -17,10 +17,6 @@ You can find pictures of the default keymaps on the [default keymaps page][keyma Alternatively, you can also plug in your keyboard and visualize the keymap using VIA (see VIA section). -## Miryoku - -The 3x5 keyboards (Skeletyl, Charybdis Nano) come flashed with [Miryoku](https://github.com/manna-harbour/miryoku). On its github repository you will find useful information on the different layers available. - # Customization For customizing your keyboard, you can: diff --git a/_includes/use_keyboard_chary.md b/_includes/use_keyboard_chary.md index 0cba2f7..64539d2 100644 --- a/_includes/use_keyboard_chary.md +++ b/_includes/use_keyboard_chary.md @@ -39,11 +39,6 @@ Sniping **slows down the trackball/trackpad**. This way, you can move the cursor By default, Sniping mode is activated when you hold the `MOUSE + SNIP` keys at the same time. You can also configure qmk to have it activated automatically. -## Miryoku - -The 3x5 keyboards (Skeletyl, Charybdis Nano) come flashed with [Miryoku](https://github.com/manna-harbour/miryoku). On its github repository you will find useful information on the different layers available. - - # Customization For customizing your keyboard, you can: From d7b336e25bb8ff6530cfa27abda91d7219950168 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:05:22 +0200 Subject: [PATCH 15/49] Update _includes/use_keyboard.md Co-authored-by: burkfers --- _includes/use_keyboard.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/use_keyboard.md b/_includes/use_keyboard.md index f1438f8..74b4597 100644 --- a/_includes/use_keyboard.md +++ b/_includes/use_keyboard.md @@ -26,7 +26,7 @@ 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). From c43971746132605dce80f932c86fb010add952dc Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:05:29 +0200 Subject: [PATCH 16/49] Update _includes/use_keyboard.md Co-authored-by: burkfers --- _includes/use_keyboard.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/use_keyboard.md b/_includes/use_keyboard.md index 74b4597..2e04d08 100644 --- a/_includes/use_keyboard.md +++ b/_includes/use_keyboard.md @@ -28,7 +28,7 @@ For customizing your keyboard, you can: 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" %} From 69764639ff31ecd8db8226d91fe90f09da7bbf90 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:05:41 +0200 Subject: [PATCH 17/49] Update _includes/use_keyboard_chary.md Co-authored-by: burkfers --- _includes/use_keyboard_chary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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" %} From 55894e73e2e48d13577d1e6a3e0a681827bf71c2 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:05:48 +0200 Subject: [PATCH 18/49] 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 fdd398d..2b708ce 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. From e3c138b20c4c9af594d89999b8cdccae9a613ab5 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:06:05 +0200 Subject: [PATCH 19/49] 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 2b708ce..ba53200 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -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. From b9cad0a8bafed3cd4440c1e602d9cc426db0967b Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:06:19 +0200 Subject: [PATCH 20/49] Update .wordlist.txt Co-authored-by: burkfers --- .wordlist.txt | 2 ++ 1 file changed, 2 insertions(+) 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 From a2cb6933a8edccb8bd19db67bcd6c8148e15fe12 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:07:03 +0200 Subject: [PATCH 21/49] 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 ba53200..5d463ac 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -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} From a7ecf074604b840ea89621bffd61923998306986 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:07:44 +0200 Subject: [PATCH 22/49] Update compile-firmware.md --- 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 fdd398d..40d2208 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -101,7 +101,7 @@ qmk compile -c -kb bastardkb/{keyboard} -km {keymap} ## `{keymap}` argument -All keyboards have a `default` keymap. Most also have a `via` keymap. The latter is already configured to work with [Via](https://usevia.app). +All keyboards have a `vendor` keymap, which is the one officially supported and shipped with Bastard Keyboards. To build *any* keymap with Via support, simply add the following argument to the command line: `-e VIA_ENABLE=yes`, e.g.: From 7d381fa9e3b3a3c4b54280c48107335baa7a7ae3 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:07:58 +0200 Subject: [PATCH 23/49] 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 5d463ac..bed5d7c 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -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: From 766c155ec16edf009c2ab7ddc4fa6aef5d509a2e Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:26:40 +0200 Subject: [PATCH 24/49] Update compile-firmware.md --- fw/compile-firmware.md | 88 +++++++++++++++++++++++++++--------------- 1 file changed, 56 insertions(+), 32 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index baba144..6c084e7 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -51,11 +51,13 @@ If you have multiple QMK installations, you will need to manually set the qmk ho While the QMK repository contains the logic behind the keyboards, the keymaps are in the userspace repository. +**If you are going to create your own keymaps, you should fork the repository.** + In a separate folder, clone the BKB QMK repository, using either github desktop or the command line: ```shell -git clone https://github.com/bastardkb/qmk_userspace +git clone https://github.com/bastardkb/qmk_userspace # or, your own fork ``` Next, `cd` into the repository and enable userspace: @@ -65,18 +67,59 @@ cd qmk_userspace qmk config user.overlay_dir="$(realpath .)" ``` -## Github actions +## Github actions {#actions-requirements} + +If you are want to use Github actions to compile your firmware (rather than the console), you will need to: + +- fork the BastardKB QMK Userspace repository +- in the `Actions` tab, enable workflows + + +# Creating your keymap + +If you want to create your own keymap, **we heavily recommend to create your own fork of the BastardKB QMK userspace.** + +This way, you can: + +- track changes +- use Github actions to compile your keymap +- (if relevant) contribute your keymap to the origin Bastard KB QMK Userspace + +Create a separate folder in the relevant folder, eg: + +``` +keyboards/bastardkb/charybdis/4x6/keymaps/my-keymap/ +``` + +Then, the easiest is to copy over an existing keymap (eg. `vendor`) over, and modify from there. + + +# Compiling with Github Actions + +First, make sure you have went through the [Github actions requirements section above](#actions-requirements). + +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: + +```shell +{ + "userspace_version": "1.0", + "build_targets": [ + ["bastardkb/charybdis/4x6", "my-keymap"] + ] +} +``` + +We also recommend deleting the other keymaps if you don't use them, as it'll make the action run faster. -// TODO screenshot enable actions workflows +Then, -// TODO mroe details, screenshots -actions tab -- "I understand my workflows, go ahead and enable them" +1. Push your changes above to your forked GitHub repository +1. Look at the GitHub Actions for a new actions run +1. Wait for the actions run to complete +1. Inspect the Releases tab on your repository for the latest firmware build -1. In the GitHub Actions tab, enable workflows -2. Push your changes above to your forked GitHub repository -3. Look at the GitHub Actions for a new actions run -4. Wait for the actions run to complete -5. Inspect the Releases tab on your repository for the latest firmware build # Compiling with console @@ -109,30 +152,11 @@ To build *any* keymap with Via support, simply add the following argument to the qmk compile -c -kb {keyboard} -km default -e VIA_ENABLE=yes ``` -# Compiling with Github Actions - -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: - -```shell -{ - "userspace_version": "1.0", - "build_targets": [ - ["bastardkb/charybdis/4x6", "my-keymap"] - ] -} -``` - -We also recommend deleting the other keymaps if you don't use them, as it'll make the action run faster. - -# Creating your own keymap - -// TODO - # Contributing your own keymap -// TODO +If you are happy with your keymap and would like to share it, we would gladly review it! + +Just PR your fork to the origin BastardKB Userspace repository. # Flashing your keyboard From ca3132c5e589317d68ce9263e8e86ffd9efae665 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:28:26 +0200 Subject: [PATCH 25/49] typo --- 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 6c084e7..ff310bd 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -69,7 +69,7 @@ qmk config user.overlay_dir="$(realpath .)" ## Github actions {#actions-requirements} -If you are 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 the console), you will need to: - fork the BastardKB QMK Userspace repository - in the `Actions` tab, enable workflows From 7518806ada583b54cf83ab55db733dda97174ffd Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 15:29:54 +0200 Subject: [PATCH 26/49] focus on userspace --- fw/compile-firmware.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index ff310bd..6d8f958 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -47,6 +47,9 @@ qmk config user.qmk_home="$(realpath .)" {: .info } 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.** + ## BastardKb userspace While the QMK repository contains the logic behind the keyboards, the keymaps are in the userspace repository. From 4ed346a15451c1aa67e2181c5b7f578124568775 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 19:49:19 +0200 Subject: [PATCH 27/49] 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 28/49] 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 29/49] 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 30/49] 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 31/49] 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: From 423a814efe497702cbaa1f5c108c72ba84ebdd5e Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 19:55:30 +0200 Subject: [PATCH 32/49] Update .wordlist.txt --- .wordlist.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.wordlist.txt b/.wordlist.txt index c06f888..0ea840d 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -61,6 +61,7 @@ multimeter keypress MCU !dilemma +dilemma TRRS KiCad Millmax From e122e82d64a4de63a9c3841f67d07b97ed28b948 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 19:58:49 +0200 Subject: [PATCH 33/49] Update .wordlist.txt --- .wordlist.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.wordlist.txt b/.wordlist.txt index 9d5d5ec..c3dc51e 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -60,8 +60,8 @@ TODO multimeter keypress MCU -!dilemma dilemma +Dilemma TRRS KiCad Millmax From 1c18d4a423c7e9f48072a74a0daaf249926427df Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 2 Aug 2024 20:02:00 +0200 Subject: [PATCH 34/49] easier to understand wording --- fw/compile-firmware.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index aea221b..10c1a87 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -14,9 +14,10 @@ parent: Firmware The [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) contains the firmware code and releases for the Bastard Keyboards Charybdis boards. -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). +That repository is used as primary source of truth for Bastard Keyboards firmwares and 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 behavioral code is stored on the QMK repository, the keymaps are stored in our [QMK userspace](https://github.com/Bastardkb/qmk_userspace). +The behavioral code is stored on the QMK repository, and 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. From 151afa9510bbaa82dd8be3e57996495b49b259f5 Mon Sep 17 00:00:00 2001 From: Quentin Date: Sun, 4 Aug 2024 11:28:22 +0200 Subject: [PATCH 35/49] separate github actions and local compile --- fw/compile-firmware.md | 124 ++++++++++++++++++++++------------------- 1 file changed, 68 insertions(+), 56 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index 10c1a87..26c233a 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -12,76 +12,37 @@ parent: Firmware # Introduction -The [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) contains the firmware code and releases for the Bastard Keyboards Charybdis boards. +The [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) contains the behavioural firmware code and releases for the Bastard Keyboards Charybdis boards. -That repository is used as primary source of truth for Bastard Keyboards firmwares and 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). +The keymaps are stored in our [QMK userspace](https://github.com/Bastardkb/qmk_userspace). -The behavioral code is stored on the QMK repository, and the keymaps are stored in our [QMK userspace](https://github.com/Bastardkb/qmk_userspace). +The QMK repository repository is used as primary source of truth for Bastard Keyboards firmwares and 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). -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. +This page details how to build your own firmware. +Building from source is useful to people who want to customize their keyboard and keymaps beyond what Via offers. +You will have to modify the keymap `C` code, and from there compile your firmware either using Github actions or the local command line. If that seems too complicated, you can also use one of the default releases, or VIA. # Pre-requisites -## Working QMK environment - -Make sure you have a functional QMK environment. See [QMK Docs](https://docs.qmk.fm/#/newbs) for details. At this point, **you don't need** to run `qmk setup`. - -## BastardKb QMK fork - -Clone the BKB QMK repository, using either github desktop or the command line, and switch to the `bkb-master` branch: - -```shell -git clone https://github.com/bastardkb/bastardkb-qmk -cd bastardkb-qmk -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. - -```shell -qmk config user.qmk_home="$(realpath .)" -``` - -{: .info } -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.** - ## BastardKb userspace While the QMK repository contains the logic behind the keyboards, the keymaps are in the userspace repository. -**If you are going to create your own keymaps, you should fork the repository.** +**If you are going to create your own keymaps, the first step is to fork the repository.** -In a separate folder, clone the BKB QMK repository, using either github desktop or the command line: +In a separate folder, clone the BKB QMK repository, using either Github desktop or the command line: ```shell -git clone https://github.com/bastardkb/qmk_userspace # or, your own fork +git clone https://github.com/my_username/qmk_userspace ``` -Next, `cd` into the repository and enable userspace: - -```shell -cd qmk_userspace -qmk config user.overlay_dir="$(realpath .)" -``` - -## Github actions {#actions-requirements} - -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 - - # Creating your keymap -If you want to create your own keymap, **we heavily recommend to create your own fork of the BastardKB QMK userspace.** +If you want to create your own keymap, **make sure to fork the BastardKB QMK userspace repository.** This way, you can: @@ -97,14 +58,25 @@ keyboards/bastardkb/charybdis/4x6/keymaps/my-keymap/ Then, the easiest is to copy over an existing keymap (eg. `vendor`) over, and modify from there. +# Compiling your firmware using Github actions -# Compiling with Github Actions +By using github actions, you can have Github compile your firmware without having to bother with a local QMK installation and console commands. -First, make sure you have went through the [Github actions requirements section above](#actions-requirements). +## Pre-requisites {#actions-requirements} + +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** + + +## Compiling your firmware + +First, make sure you have gone through the [Github actions requirements section above](#actions-requirements). 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 keymaps to be compiled in `qmk.json`, for example: +Once 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 { @@ -125,7 +97,47 @@ Then, 1. Inspect the Releases tab on your repository for the latest firmware build -# Compiling locally +# Compiling your firmware using the local command line + +You can also compile your firmware through your local command line. This requires you to be familiar with the console, and doing some additional configuration. + +## Pre-requisites + +### Working QMK environment + +Make sure you have a functional QMK environment. See [QMK Docs](https://docs.qmk.fm/#/newbs) for details. At this point, **you don't need** to run `qmk setup`. + +### BastardKb QMK fork + +Clone the BKB QMK repository, using either github desktop or the command line, and switch to the `bkb-master` branch: + +```shell +git clone https://github.com/bastardkb/bastardkb-qmk +cd bastardkb-qmk +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. + +```shell +qmk config user.qmk_home="$(realpath .)" +``` + +{: .info } +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.** + +### QMK Userspace + +Next, `cd` into your userspace fork and enable userspace: + +```shell +qmk config user.overlay_dir="$(realpath .)" +``` + +## Compiling your firmware Once in the QMK userspace repository, compiling a keymap works the same as normal: @@ -133,7 +145,7 @@ Once in the QMK userspace repository, compiling a keymap works the same as norma qmk compile -c -kb bastardkb/{keyboard} -km {keymap} ``` -## `{keyboard}` argument +### `{keyboard}` argument `{keyboard}` corresponds to the physical keyboard you are building the firmware for. It can be one of the following: @@ -146,7 +158,7 @@ qmk compile -c -kb bastardkb/{keyboard} -km {keymap} - `dilemma/3x5_3`: the 3x5+3 [Dilemma](https://github.com/bastardkb/dilemma/) - `dilemma/4x6_4`: the 4x6+4 [Dilemma Max](https://github.com/bastardkb/dilemma/) -## `{keymap}` argument +### `{keymap}` argument All keyboards have a `vendor` keymap, which is the one officially supported and shipped with Bastard Keyboards. From af13aa69b208f924a808fb1ec82eda2599539abe Mon Sep 17 00:00:00 2001 From: Quentin Date: Sun, 4 Aug 2024 11:28:25 +0200 Subject: [PATCH 36/49] Update .wordlist.txt --- .wordlist.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.wordlist.txt b/.wordlist.txt index c3dc51e..5ed9cf9 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -60,6 +60,7 @@ TODO multimeter keypress MCU +!dilemma dilemma Dilemma TRRS From a92abbb0e416c483c5cbfed875c2c5f9b7f529c6 Mon Sep 17 00:00:00 2001 From: Quentin Date: Sun, 4 Aug 2024 11:31:12 +0200 Subject: [PATCH 37/49] Update compile-firmware.md --- 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 26c233a..f48b383 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -33,7 +33,7 @@ While the QMK repository contains the logic behind the keyboards, the keymaps ar **If you are going to create your own keymaps, the first step is to fork the repository.** -In a separate folder, clone the BKB QMK repository, using either Github desktop or the command line: +In a separate folder, clone the fork you just created, using either Github desktop or the command line: ```shell From 6753af62ffb4302f27a5f413a9a76419535f8b84 Mon Sep 17 00:00:00 2001 From: Quentin Date: Mon, 5 Aug 2024 11:02:08 +0200 Subject: [PATCH 38/49] add lowercase keymap note --- fw/compile-firmware.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index f48b383..a074bc2 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -56,6 +56,10 @@ Create a separate folder in the relevant folder, eg: keyboards/bastardkb/charybdis/4x6/keymaps/my-keymap/ ``` + +{: .note } +By convention, your keymap name must be all lowercase, without spaces. + Then, the easiest is to copy over an existing keymap (eg. `vendor`) over, and modify from there. # Compiling your firmware using Github actions From 7222de51494ddf09e93f07118eea977c7730936f Mon Sep 17 00:00:00 2001 From: Quentin Date: Mon, 5 Aug 2024 11:31:03 +0200 Subject: [PATCH 39/49] more userspace links --- fw/compile-firmware.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index a074bc2..2720568 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -31,7 +31,7 @@ If that seems too complicated, you can also use one of the default releases, or While the QMK repository contains the logic behind the keyboards, the keymaps are in the userspace repository. -**If you are going to create your own keymaps, the first step is to fork the repository.** +**If you are going to create your own keymaps, the first step is to fork the [BastardKB QMK userspace repository](https://github.com/Bastardkb/qmk_userspace).** In a separate folder, clone the fork you just created, using either Github desktop or the command line: @@ -42,7 +42,7 @@ git clone https://github.com/my_username/qmk_userspace # Creating your keymap -If you want to create your own keymap, **make sure to fork the BastardKB QMK userspace repository.** +If you want to create your own keymap, **make sure to fork the [BastardKB QMK userspace repository](https://github.com/Bastardkb/qmk_userspace).** This way, you can: From 5f7a144ff251b56663d8a125dcbf7a2d24e6f02c Mon Sep 17 00:00:00 2001 From: Quentin Date: Mon, 5 Aug 2024 11:41:17 +0200 Subject: [PATCH 40/49] clean up links --- fw/compile-firmware.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index 2720568..966b63d 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -14,7 +14,7 @@ parent: Firmware The [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) contains the behavioural firmware code and releases for the Bastard Keyboards Charybdis boards. -The keymaps are stored in our [QMK userspace](https://github.com/Bastardkb/qmk_userspace). +The keymaps are stored in the [BastardKB QMK userspace repository][bkbus]. The QMK repository repository is used as primary source of truth for Bastard Keyboards firmwares and 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). @@ -31,7 +31,14 @@ If that seems too complicated, you can also use one of the default releases, or While the QMK repository contains the logic behind the keyboards, the keymaps are in the userspace repository. -**If you are going to create your own keymaps, the first step is to fork the [BastardKB QMK userspace repository](https://github.com/Bastardkb/qmk_userspace).** +**If you are going to create your own keymaps, the first step is to fork the [BastardKB QMK userspace repository][bkbus].** + + +This way, you can: + +- track changes +- use Github actions to compile your keymap +- (if relevant) contribute your keymap to the origin Bastard KB QMK Userspace In a separate folder, clone the fork you just created, using either Github desktop or the command line: @@ -42,13 +49,7 @@ git clone https://github.com/my_username/qmk_userspace # Creating your keymap -If you want to create your own keymap, **make sure to fork the [BastardKB QMK userspace repository](https://github.com/Bastardkb/qmk_userspace).** - -This way, you can: - -- track changes -- use Github actions to compile your keymap -- (if relevant) contribute your keymap to the origin Bastard KB QMK Userspace +If you want to create your own keymap, **make sure you have forked the [BastardKB QMK userspace repository][bkbus].** Create a separate folder in the relevant folder, eg: @@ -187,4 +188,5 @@ For how to flash your keyboard, take a look at the [how to flash your keyboard p --- -[flashing]: {{site.baseurl}}/fw/flashing.html \ No newline at end of file +[flashing]: {{site.baseurl}}/fw/flashing.html +[bkbus]: https://github.com/Bastardkb/qmk_userspace \ No newline at end of file From afb5f1107c40e1e06862fd3f8760a710f4dbdf6f Mon Sep 17 00:00:00 2001 From: Quentin Date: Tue, 6 Aug 2024 11:30:40 +0200 Subject: [PATCH 41/49] Update .wordlist.txt Co-authored-by: burkfers --- .wordlist.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/.wordlist.txt b/.wordlist.txt index 5ed9cf9..c3dc51e 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -60,7 +60,6 @@ TODO multimeter keypress MCU -!dilemma dilemma Dilemma TRRS From cf2e742abc0d6c60420283223b5d136eb7f3f19f Mon Sep 17 00:00:00 2001 From: Quentin Date: Tue, 6 Aug 2024 11:30:46 +0200 Subject: [PATCH 42/49] Update .wordlist.txt Co-authored-by: burkfers --- .wordlist.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/.wordlist.txt b/.wordlist.txt index c3dc51e..11a4f25 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -60,7 +60,6 @@ TODO multimeter keypress MCU -dilemma Dilemma TRRS KiCad From 2dd92b194564fe381b288c1057e93ad9a4edc090 Mon Sep 17 00:00:00 2001 From: Quentin Date: Tue, 6 Aug 2024 11:30:57 +0200 Subject: [PATCH 43/49] 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 966b63d..71b545a 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -12,7 +12,7 @@ parent: Firmware # Introduction -The [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) contains the behavioural firmware code and releases for the Bastard Keyboards Charybdis boards. +The [BastardKB QMK repository](https://github.com/bastardkb/bastardkb-qmk) contains the behavioral firmware code and releases for the Bastard Keyboards Charybdis boards. The keymaps are stored in the [BastardKB QMK userspace repository][bkbus]. From b74fd6a0424a0f27a9129fc554a12a3af8727167 Mon Sep 17 00:00:00 2001 From: Quentin Date: Tue, 6 Aug 2024 11:33:33 +0200 Subject: [PATCH 44/49] add releases link --- 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 966b63d..65fca0b 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -23,7 +23,7 @@ This page details how to build your own firmware. Building from source is useful to people who want to customize their keyboard and keymaps beyond what Via offers. You will have to modify the keymap `C` code, and from there compile your firmware either using Github actions or the local command line. -If that seems too complicated, you can also use one of the default releases, or VIA. +If that seems too complicated, you can also use one of the [default releases](https://github.com/Bastardkb/bastardkb-qmk/releases/latest), or VIA. # Pre-requisites From a19e2f2bc9bba4534aa33c546a8378227390d924 Mon Sep 17 00:00:00 2001 From: Quentin Date: Tue, 6 Aug 2024 11:39:41 +0200 Subject: [PATCH 45/49] update keymap argument --- fw/compile-firmware.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index dd6d6d2..3a13582 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -165,14 +165,14 @@ qmk compile -c -kb bastardkb/{keyboard} -km {keymap} ### `{keymap}` argument -All keyboards have a `vendor` keymap, which is the one officially supported and shipped with Bastard Keyboards. + +`{keymap}` corresponds to the keymap that you are compiling. If you followed the instructions until now, you can use `my-keymap`. To build *any* keymap with Via support, simply add the following argument to the command line: `-e VIA_ENABLE=yes`, e.g.: ```shell -qmk compile -c -kb {keyboard} -km default -e VIA_ENABLE=yes +qmk compile -c -kb charybdis/4x6 -km my-keymap -e VIA_ENABLE=yes ``` - # Contributing your own keymap If you are happy with your keymap and would like to share it, we would gladly review it! From a850daf1a70668cd25e214ce660cb19657100838 Mon Sep 17 00:00:00 2001 From: Quentin Date: Tue, 6 Aug 2024 11:40:10 +0200 Subject: [PATCH 46/49] 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 3a13582..a6088a0 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -23,7 +23,7 @@ This page details how to build your own firmware. Building from source is useful to people who want to customize their keyboard and keymaps beyond what Via offers. You will have to modify the keymap `C` code, and from there compile your firmware either using Github actions or the local command line. -If that seems too complicated, you can also use one of the [default releases](https://github.com/Bastardkb/bastardkb-qmk/releases/latest), or VIA. +If that seems too complicated, you can also use one of the [release firmware](https://github.com/Bastardkb/bastardkb-qmk/releases/latest) builds. # Pre-requisites From ee92bf64ab9d3f66476f8cc2192e3e9436a8f926 Mon Sep 17 00:00:00 2001 From: Quentin Date: Tue, 6 Aug 2024 11:41:19 +0200 Subject: [PATCH 47/49] 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 a6088a0..ff1f87d 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -27,7 +27,7 @@ If that seems too complicated, you can also use one of the [release firmware](ht # Pre-requisites -## BastardKb userspace +## BastardKB userspace While the QMK repository contains the logic behind the keyboards, the keymaps are in the userspace repository. From b9c48ea69bf369e1172fa13b83fce1fbc86585a9 Mon Sep 17 00:00:00 2001 From: Quentin Date: Tue, 6 Aug 2024 11:41:27 +0200 Subject: [PATCH 48/49] 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 ff1f87d..e75dc2c 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -112,7 +112,7 @@ You can also compile your firmware through your local command line. This require Make sure you have a functional QMK environment. See [QMK Docs](https://docs.qmk.fm/#/newbs) for details. At this point, **you don't need** to run `qmk setup`. -### BastardKb QMK fork +### BastardKB QMK fork Clone the BKB QMK repository, using either github desktop or the command line, and switch to the `bkb-master` branch: From ccf8d751b937abb017dc59588902d6c1f9297a05 Mon Sep 17 00:00:00 2001 From: Quentin Date: Tue, 6 Aug 2024 11:42:48 +0200 Subject: [PATCH 49/49] remove via stuff --- fw/compile-firmware.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/fw/compile-firmware.md b/fw/compile-firmware.md index 3a13582..373ea8b 100644 --- a/fw/compile-firmware.md +++ b/fw/compile-firmware.md @@ -166,13 +166,10 @@ qmk compile -c -kb bastardkb/{keyboard} -km {keymap} ### `{keymap}` argument -`{keymap}` corresponds to the keymap that you are compiling. If you followed the instructions until now, you can use `my-keymap`. +`{keymap}` corresponds to the keymap that you created. -To build *any* keymap with Via support, simply add the following argument to the command line: `-e VIA_ENABLE=yes`, e.g.: +If you followed the instructions until now, it would be `my-keymap`. -```shell -qmk compile -c -kb charybdis/4x6 -km my-keymap -e VIA_ENABLE=yes -``` # Contributing your own keymap If you are happy with your keymap and would like to share it, we would gladly review it!