Skip to content

Commit

Permalink
Add warning that flashing wipes Vial layout
Browse files Browse the repository at this point in the history
  • Loading branch information
SiriusStarr committed Sep 11, 2024
1 parent fb4cdbe commit fa37961
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions keyboards/svalboard/docs/flashing_firmware.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
# Flashing Firmware

* [Flashing Firmware](#flashing-firmware)
* [Before You Begin](#before-you-begin)
* [Introduction](#introduction)
* [Finding And Downloading The Right Firmware](#finding-and-downloading-the-right-firmware)
* [Flashing Your Downloaded Firmware](#flashing-your-downloaded-firmware)
* [Troubleshooting](#troubleshooting)

## Before You Begin

If you've done any customization of your layout, make sure you **save your
layout** in Vial! Flashing firmware will cause the loss of your current layout.

![The "Save current layout" entry in the "File" menu of Vial, along with the Ctrl+S shortcut.](images/save_vil.png)

## Introduction

While your Svalboard should work great with the firmware on it, if you're doing
Expand Down Expand Up @@ -43,6 +51,8 @@ above image).
Once you've located and downloaded both files you'll need, you will need to
flash each Svalboard half independently. To flash a half:

**Make certain you have saved your layout in Vial!**

* Ensure that that side (right or left) is plugged into your computer as the
primary/master. The USB cable connected to your computer should be plugged
into the port labeled `U`, **not** the one labeled `S`.
Expand All @@ -61,6 +71,11 @@ flash each Svalboard half independently. To flash a half:
**Don't forget to do the other half, which will require changing which side the
USB cable is plugged into!**

Once you're finished, reload your saved Vial layout.

![The "Load saved layout" entry in the "File" menu of Vial, along with the
Ctrl+O shortcut.](images/load_vil.png)

## Troubleshooting

Once both halves are flashed, if things don't seem to work, try unplugging and
Expand Down
Binary file added keyboards/svalboard/docs/images/load_vil.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added keyboards/svalboard/docs/images/save_vil.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fa37961

Please sign in to comment.