diff --git a/README.md b/README.md index 44233ff..4423382 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,32 @@ It's my personal layout for the [custom build](https://gitea.dmz.rs/Decentrala/c ![Overview Alternative](/images/photos/overview_alt.jpg?raw=true) > "Tastatura" is the Serbian word for "keyboard". +## Initial Flash + +- Clone the Vial repository: + ``` + git clone --recurse-submodules git@github.com:vial-kb/vial-qmk.git + cd vial-qmk + ``` +- (Optional) Change the layer count in the config: + ``` + vial-qmk/keyboards/cantor/keymaps/vial/config.h + ``` +- Connect the controller to your computer using a USB cable +- Start the flashing process for the controller (Docker required): + ``` + sudo util/docker_build.sh cantor:vial:flash + ``` +- Use the onboard BOOT0 and NRST button to put the board into bootloader mode: + - press and hold the BOOT0 button + - press and release NRST (reset) button to power cycle the processor + - release BOOT0 button + - For additional details, refer to: [STM32 Black Pill](https://land-boards.com/blwiki/index.php?title=STM32_Black_Pill) +- Repeat the flashing process for the second controller. +- Download the Vial configurator: https://get.vial.today/ +- Configure udev rules for the first launch: https://get.vial.today/manual/linux-udev.html +- Open the Vial configurator. + ## Layout ### Base Layer