From 0a46a7d63e58ffafb143fcda130e6058c3837490 Mon Sep 17 00:00:00 2001 From: cyberboy666 Date: Thu, 24 Mar 2022 10:10:49 +1300 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2b9c766..ac89dcb 100644 --- a/README.md +++ b/README.md @@ -111,11 +111,33 @@ follow this link to view the [interactive BOM](https://htmlpreview.github.io/?ht - finally place and solder the pots and jacks. + + +## firmware guide + +
firmware guide - for editing the code & flashing it to your micro-controller + ## flashing firmware onto the micro-controller -if you have got a kit from the shop the firmware will be pre-configured - still you might want to read this so you can edit the code and update the midi mapping. +if you have got a kit from the shop the default firmware will be pre-configured - still you probably will want to follow this so you can edit the code and update the mappings. + +### install guide + +all _underscores_ projects with micro-controllers use [platformio](https://platformio.org/) with [visual studio code](https://code.visualstudio.com/) to edit, flash and monitor the code. + +- first download (and unzip) the code in this repo - easiest is [as a zip](https://github.com/cyberboy666/c_l_i_k_r/archive/refs/heads/main.zip) or you can clone using git if you are comfortable with this +- next download, install and open [visual studio code](https://code.visualstudio.com/#alt-downloads) +- now open the extension tab within vscode on left vertical menu (or press ctrl-shift-x) and search for `platformio` to install this extension + +![image](https://user-images.githubusercontent.com/12017938/158495161-7c3114fc-814b-4acc-b142-4a9522370473.png) -[more details coming soon] +- connect the micro-controller to computer via usb, open the c_l_i_k_r software folder (ctrl-k ctrl-o) in vscode and find the _platformio_ commands (either in left vertical menu under _platformio_ or little tick/arrow symbols along bottom blue bar) - `PlatformIO: Upload` should flash the default code to your micro-controller + +![image](https://user-images.githubusercontent.com/12017938/158495844-99466196-086a-47d2-b803-2b5941d33ac5.png) + +### mapping edit guide + +coming soon