58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
# Installation scripts to use Wokwi and Arduino in VSCode/VSCodium
|
|
|
|
## Installation steps
|
|
|
|
### Install linux Dependencies
|
|
|
|
Install the xdotool package:
|
|
|
|
Debian based distros:
|
|
`sudo apt install xdotool`
|
|
|
|
Arch based distros:
|
|
`sudo pacman -S xdotool`
|
|
|
|
### VSCode/VSCodium configuration
|
|
|
|
Install the Wokwi extension and request the license key [here](https://wokwi.com/license):
|
|
|
|
Extension for VSCode [here](https://marketplace.visualstudio.com/items?itemName=Wokwi.wokwi-vscode)
|
|
|
|
Extension for VSCodium [here](https://open-vsx.org/extension/Wokwi/wokwi-vscode)
|
|
|
|
To activate the license key open the IDE press `F1` and select `Wokwi: Manually Enter License Key` and paste the license key
|
|
|
|
### Installation Script
|
|
|
|
Change directory into the project folder and do the following.
|
|
|
|
For linux execute the `install-linux.sh` script with:
|
|
|
|
```
|
|
bash install-linux.sh
|
|
```
|
|
|
|
For windows just execute the `install-windows.bat` script
|
|
|
|
## After the installation process
|
|
|
|
After the installation is completed you will have the following project structure:
|
|
|
|
### Project Structure
|
|
|
|
.vscode/ --> VSCode config files
|
|
run
|
|
tasks.json
|
|
bin/ --> Binnaries and executables
|
|
arduino-cli
|
|
code/ --> Main project code directory
|
|
code.ino
|
|
libs/ --> Arduino library's
|
|
.gitignore
|
|
diagram.json --> Wokwi diagram/circuit
|
|
wokwi.toml --> wokwi config file
|
|
|
|
### How to use
|
|
|
|
You can compile and execute the arduino project/sketch just by pressing `Ctrl` + `Shift` + `B`.
|