eessppeelllloo/c_l_i_k_r
1
0
Fork 0
mirror of https://github.com/cyberboy666/c_l_i_k_r.git synced 2025-12-05 22:40:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
cyberboy666
2022-03-24 10:10:49 +13:00
committed by GitHub
parent 3f32d1c370
commit 0a46a7d63e
1 changed files with 24 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -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. - finally place and solder the pots and jacks.
</details>
## firmware guide
<details><summary><b>firmware guide</b> - for editing the code & flashing it to your micro-controller</summary>
## flashing firmware onto the 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.
[more details coming soon] ### 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)
- 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
</details> </details>