Skip to content

Commit b8c223a

Browse files
committed
text changes
1 parent df749fa commit b8c223a

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

Documents/firmware-install.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44
## Bootloader
5-
The bootloader only has to be flashed if you are building your own board from scratch, have a board purchased between June 12 and June 22 2020 which will not enter the bootloader from a software reset, or have bricked your board and need to bring it back to life.
5+
__The bootloader only has to be flashed if you are building your own board from scratch, have a board purchased between June 12 and June 22 2020 which will not enter the bootloader from a software reset, or have bricked your board and need to bring it back to life.__
66

77
* To make life easy I recommend flashing the Arduino bootloader onto the microcontroller, however if you already have the Atmel DFU bootloader on your device, feel free to change the bootloader in `rules.mk` to `atmel-dfu` and skip the next step.
88

@@ -12,19 +12,24 @@ The bootloader only has to be flashed if you are building your own board from sc
1212

1313
With the bootloader on the microcontroller, we can now flash the QMK firmware onto the device.
1414

15-
## QMK
16-
Precompiled binaries are available at `Firmware/binaries` for the keyboard if you do not want to compile it from source, and can be flashed using [QMK Toolbox](https://github.com/qmk/qmk_toolbox).
15+
## QMK - (Keymap)
1716

18-
To build the firmware from source:
17+
### Flashing Precompiled keymaps
18+
19+
Precompiled binaries are available through the [QMK Toolbox](https://github.com/qmk/qmk_toolbox), the [Via website](https://caniusevia.com/docs/download_firmware) or in the `Firmware/binaries` directory if you do not want to compile it from source, and can be flashed using [QMK Toolbox](https://github.com/qmk/qmk_toolbox) or the QMK Command line tool.
20+
21+
When flashing with [QMK Toolbox](https://github.com/qmk/qmk_toolbox), make sure you have your desired keymap selected and the MCU is set to atmega32u4.
22+
23+
### To build the firmware from source
1924

2025
* Follow the [Getting Started Guide](https://docs.qmk.fm/#/newbs_getting_started) for your OS to install the toolchain and required files.
2126

22-
If programming theh board for the first time, we want to confirm all keys / encoders work, and will flash firmware which does not wrap the key presses.
27+
If programming the board for the first time, we want to confirm all keys / encoders work, and will flash firmware which does not wrap the key presses.
2328
* Connect your keyboard and run `make hub16:no_mod:flash`, or flash `hub16_no_mod.bin` with QMK Toolbox.
2429
* Follow the on screen prompts to reset your keyboard when required for the device to be flashed - the reset button is located on the back of the PCB.
2530
* You can now use something conductive (tweezers, paperclip) to short out the keyswitch and encoder switch contacts to ensure all keys work, along with pressing a rotary encoder against its three pins to check its function.
2631
* You should see each switch / encoder type a unique letter, if there are duplicates or no text, look for bad solder joints on the PCB, in particular the microcontroller pins and resistor packs.
2732

28-
If all of the keys work, flash the real firmware with `make hub16:default:flash` (or `hub16_default.bin` for QMK Toolbox), and your keyboard should be good to go.
29-
* If you plan to use it with VIA, run `make hub16:via:flash` (or `hub16_via.bin` for QMK Toolbox), and your keyboard should be good to go.
33+
If all of the keys work, flash the real firmware with `make hub16:default:flash`, and your keyboard should be good to go.
34+
* If you plan to use it with VIA, run `make hub16:via:flash` and your keyboard should be good to go.
3035
* If desired, check out the [Test Procedue](test-procedure.md) to confirm everything works as planned, and the head to the [mechanical assembly](Documents/enclosure-manufacturing.md) instructions to finish your build.

0 commit comments

Comments
 (0)