Skip to content

Commit

Permalink
link how to flash page from build guides
Browse files Browse the repository at this point in the history
  • Loading branch information
bstiq committed Jul 25, 2024
1 parent c0f7888 commit d8bbbdf
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
7 changes: 5 additions & 2 deletions _includes/customize_keyboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ The 3x5 keyboards (Skeletyl, Charybdis Nano) come flashed with [Miryoku](https:/

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).

You can find instructions on **how to flash your keyboard** with a new image here: [flashing][How to flash your keyboard].

## 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).
Expand All @@ -61,11 +63,12 @@ Through VIA, you can customize:

## Using QMK

For how to flash your keyboard, take a look at the [readme on the BKB QMK Fork](https://github.com/Bastardkb/bastardkb-qmk).
For how to flash your keyboard, take a look at the [how to flash your keyboard page][flashing].

For **advanced customization of the Charybdis and Charybdis Nano**, take a look at the [customize page][customize].

---

[customize]: {{site.baseurl}}/fw/charybdis-features.html
[keymaps]: {{site.baseurl}}/fw/default-keymaps.html
[keymaps]: {{site.baseurl}}/fw/default-keymaps.html
[flashing]: {{site.baseurl}}/fw/flashing.html
17 changes: 14 additions & 3 deletions fw/flashing.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ parent: Firmware
1. TOC
{:toc}

# Flashing
# Introduction

There are 2 ways of customizing your Bastard Keyboard:
- using VIA through a web interface
- flashing your own firmware

*Flashing* refers to writing a new firmware binary onto a controller. This article will describe the process and the various ways of initiating it.

Expand All @@ -23,13 +27,20 @@ A note about the TRS/TRRS cable: It does not disturb the flashing process and ca

To flash your new image, you will need to go through a few steps:

- compile your own firmware (not covered in this article), or get it from the BKB firmware [releases][releases]
- source your own firmware
- put the keyboard into bootloader mode
- copy the image to the USB drive
- (if needed) flash the other hand

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 can be done in a couple ways:

// TODO fix link build?

- downloading it from the [release section on github][releases]
- build your own firmware, [detailed here][build]

# Bootloader

The first step is to put your keyboard into bootloader mode. During this time it will not function as a keyboard, but it will be ready to receive new firmware.
Expand Down Expand Up @@ -117,7 +128,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
[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

0 comments on commit d8bbbdf

Please sign in to comment.