Skip to content

Commit

Permalink
Update sf2040.md
Browse files Browse the repository at this point in the history
  • Loading branch information
strayfade committed Feb 20, 2024
1 parent fc56d1b commit dc0b569
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions posts/sf2040.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,22 @@ The sf2040 is a mechanical 76-key keyboard based on the [RP2040](https://datashe
- Case filler (I used off-brand polyester fiber)

### Firmware
This keyboard runs standard [QMK firmware](https://docs.qmk.fm/#/), configuration for which is included in this repository.
This keyboard runs standard [QMK firmware](https://docs.qmk.fm/#/), configuration for which is included in the repository.

`Make` example for this keyboard (after setting up your build environment):
> The firmware can be downloaded pre-configured for this keyboard [here](https://github.com/strayfade/sf2040/raw/main/firmware/builds/sf2040.uf2).
make strayfade2040:default
The contents of the `firmware` folder in the repository should be copied into QMK's working keyboard directory (usually `qmk_firmware/keyboards`) before building.

Flashing example for this keyboard:
Build with support for VIA enabled:
```sh
qmk compile -kb sf2040 -km via
```

make strayfade2040:default:flash
The RP2040's bootloader can be accessed by holding the **ESC** key while plugging in the keyboard. Then, simply drag-and-drop the output `.uf2` firmware into the bootloader folder.

The RP2040's bootloader can be accessed by holding the **ESC** key while plugging in the keyboard.
This keyboard has **not** been merged into the [QMK repository](https://github.com/qmk/qmk_firmware/tree/master/keyboards) or [VIA's keyboard repository](https://github.com/the-via/keyboards), so you will need to define a custom board in VIA by navigating to the Settings tab, enabling the Design tab, and clicking "Load Draft Definition". From here, select the [via.json](/firmware/sf2040/via.json) file to configure the keyboard.

> For more information about setting up and working with [QMK](https://docs.qmk.fm/#/) keyboard firmware, read the QMK documentation (https://docs.qmk.fm).
### License
The sf2040 keyboard design and firmware is released under the GPL3 license. Contributions and pull requests to this repository are always welcome!
The sf2040 keyboard design and firmware is released under the GPL3 license. Contributions and pull requests to the repository are always welcome!

0 comments on commit dc0b569

Please sign in to comment.