diff --git a/README.md b/README.md index 374e2ee28d..c993caccc9 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,11 @@ For specific toolchain installation, follow instructions in the version of the documentation is uploaded daily to [doc.riot-os.org](https://doc.riot-os.org). +Using Windows? Use [this guide][dev-setup-windows] to +[setup the development environment][dev-setup-windows]. + +[dev-setup-windows]: doc/guides/setup-windows + ## Forum Do you have a question, want to discuss a new feature, or just want to present your latest project using RIOT? Come over to our [forum] and post to your hearts diff --git a/doc/doxygen/src/getting-started.md b/doc/doxygen/src/getting-started.md index 1b6579117e..c648707749 100644 --- a/doc/doxygen/src/getting-started.md +++ b/doc/doxygen/src/getting-started.md @@ -34,7 +34,12 @@ will also be fine - however, we rely on users to report bugs regarding tooling i here. So expect occasional issues for the development branch and please help testing during the feature freeze period, if you develop on macOS or BSD. -Native development on Windows and macOS machines is not officially supported. What works well is using Linux +Windows users can refer to [this guide][dev-setup-windows] to +[setup the development environment][dev-setup-windows] on Windows. + +[dev-setup-windows]: doc/guides/setup-windows + +Native development on macOS machines is not officially supported. What works well is using Linux in a virtual machine, but at much lower performance than running Linux natively. We also offer Docker images. For development on Windows, using the [Windows Subsystem for Linux (WSL)](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux) diff --git a/doc/guides/setup-windows/README.md b/doc/guides/setup-windows/README.md new file mode 100644 index 0000000000..085d12eb8e --- /dev/null +++ b/doc/guides/setup-windows/README.md @@ -0,0 +1,496 @@ +# Getting Started on Windows + +> [!NOTE] +> The documentation is quite verbose: The process is documented down to every +> click. Because of this verbosity the setup may appear complex and long, but +> in fact is rather straight forward. A novice user should be able to complete +> all steps in less than 30 minutes. + +> [!NOTE] +> Do not be afraid to ask for help e.g. in [our forum][riot-forum] + +[riot-forum]: https://forum.riot-os.org/ + +## Install Ubuntu LTS + +![Searching Ubuntu LTS in the Windows Store](img/00-Install_Ubuntu-00.png) + +1. Open the Windows Store +2. Type "Ubuntu LTS" in the search bar +3. Click on the most recent version (highest number) of Ubuntu LTS found. + As of February 2024, this is version Ubuntu 22.04.3 LTS. + +![The Ubuntu LTS page in the Windows Store](img/00-Install_Ubuntu-01.png) + +1. Click on the button labeled "Get" + + +![The Windows Store App is installing Ubuntu LTS](img/00-Install_Ubuntu-02.png) + +It will take a while for Ubuntu LTS to be installed. + +![The Windows Store App has completed installing Ubuntu LTS](img/00-Install_Ubuntu-03.png) + +Eventually, the installation completes. + +1. Click on the button labeled "Open" + +> [!WARNING] +> If the Windows Subsystem for Linux (WSL) has not yet been enabled, an error +> such as below will show. Not to worry, the next section got you covered. + +![Error message because WSL is not enabled](img/00-Install_Ubuntu-04.png) + +## Enabling WSL + +> [!NOTE] +> If an Ubuntu terminal opened just fine, proceed directly to the next section. +> This section will show how to enable WSL for those who hit the error. + +![Opening the PowerShell as administrator](img/01-Install_WSL-00.png) + +1. Search for "powershell" in the search field of the task bar +2. ***Right***-click on the hit "Windows PowerShell" +3. Click "Run as administrator" + +![Prompt asking for confirmation to run PowerShell as admin](img/01-Install_WSL-01.png) + +1. Click "Yes" to confirm running the PowerShell as administrator + +![PowerShell terminal opened as administrator](img/01-Install_WSL-02.png) + +- Type `wsl --install` and confirm with the return-key. +- After a while, the following message should appear: + +![PowerShell after WSL has been enabled](img/01-Install_WSL-03.png) + +- Now reboot Windows to complete the installation + +![Windows installing WSL during reboot](img/01-Install_WSL-04.png) + +The reboot will take longer than usual due to the installation of WSL. You +may see a screen like above for some time. Once the reboot is completed, +an Ubuntu terminal should open automatically. + +## Setup Ubuntu LTS + +You should now see an Ubuntu terminal such as: + +![An Ubuntu terminal when first started](img/02-Setup_Ubuntu-00.png) + +
If no Ubuntu terminal has opened, click here to see how to open it + +![Open Ubuntu in the start menu](img/02-Setup_Ubuntu-01.png) + +1. Click on the Start / Windows button in the task bar +2. Click on the "Ubuntu" entry + +
+ +- Enter a user name of your choice, memorize it, and confirm with the return-key +- Enter a password of your choice, memorize it, and confirm with the return-key +- Repeat the password and confirm with the return-key + +> [!WARNING] +> When typing passwords in the Ubuntu terminal, the chars entered will not +> appear on the screen and neither will appear `*`. You will have to type +> "blindly". This is an intentional security feature. + +> [!NOTE] +> If you fail to repeat the password correctly, the setup will just again. So +> no need to worry. + +- Once you successfully have entered user name and password, you should see + something like this: + +![Ubuntu terminal after username and password are configured](img/02-Setup_Ubuntu-02.png) + +- now type (without quotation signs) "sudo apt update" and confirm with the return-key +- you will be asked for you password. Enter it and confirm with the return key + +> [!WARNING] +> When typing the password, you will no get any visible feedback such as the +> typed password or `*` chars. This is an intentional security feature. + +- Once you successfully entered the password, something like this will show up: + +![Ubuntu terminal after running apt update](img/02-Setup_Ubuntu-03.png) + +> [!NOTE] +> The command `sudo apt update` only updates the list of available software +> packages in Ubuntu. Updating the installed software requires to additionally +> run `sudo apt upgrade` + +- Now type `sudo apt upgrade` and confirm with the return-key + +> [!NOTE] +> This time you likely will not need to confirm with your password again. The +> `sudo` command that allows you to run administrative commands such as +> `apt update` will skip the password entry, when heuristics indicate that +> you have not left your machine since you last confirmed a command with your +> password. + +- This command will list which packages are about to be updated. Confirm with + with the return-key +- Eventually after all software packages in Ubuntu have been updated, you will + see something like this: + +![Ubuntu terminal after updating software](img/02-Setup_Ubuntu-05.png) + + +> [!NOTE] +> It is recommended to regularly update the installed software in Ubuntu +> using `sudo apt update` followed by `sudo apt upgrade` + +## Installation of the required software packages in Ubuntu + +- Now, install the required software by typing the following and confirming it + with a return-key + +``` +sudo apt install make gcc-multilib python3-serial wget unzip git openocd gdb-multiarch esptool podman-docker clangd clang +``` + +- This will show something like this: + +![Ubuntu terminal waiting for confirmation for installation](img/03-Install_Base_Packages-01.png) + +- Confirm the installation by hitting the return-key +- The installation process will take some time +- Eventually the output will look like below (except for the `exit`) + +![Ubuntu terminal after installation completed](img/03-Install_Base_Packages-02.png) + +- Type `exit` and confirm with the return-key to close the Ubuntu terminal +- The window should close + +## Installing VS Code + +![Windows Store page of VS Code](img/04-Install_VS_Code-00.png) + +1. Click on the Windows Store icon to open the Windows store +2. Type `vs code` in the search bar +3. Click on the "Visual Studio Code by Microsoft Corporation" search result + (not shown in the screenshot above) +4. In the Windows Store page of VS Code (as shown in the screenshot above), + click on the button labeled "Install" + +![Windows Store installing VS Code](img/04-Install_VS_Code-01.png) + +- Downloading and installing VS Code by the Store App may take some time +- Eventually, it should show something like this: + +![Windows Store completed installing VS Code](img/04-Install_VS_Code-02.png) + +- Now, launch VS Code via the start menu +- On the first launch, VS code will look similar to this: + +![First Launch page of VS Code](img/04-Install_VS_Code-03.png) + +- You can select a theme of you liking +- You might want to dial back the data collection by Microsoft by clicking on "opt out" + +![Installation of the WSL extension for VS Code](img/04-Install_VS_Code-04.png) + +1. Open the extension marketplace by clicking on the extensions icon in the + left menu bar +2. Search for `wsl` in the search field +3. Click on the "Install" button for the "WSL" extension by "Microsoft" + +> [!NOTE] +> The installation of the WSL extension will complete the next time you open +> Ubuntu terminal. If the Ubuntu terminal was still open, close it using the +> `exit` comment and launch it again. + +## Cloning the RIOT Repository and First Steps in the Terminal + +> [!NOTE] +> Even if you subsequently work only via VS Code, do **NOT** skip this step. +> You will still need a "clone" of the RIOT Repository to work with. + +![Cloning of the RIOT Repo in the Ubuntu terminal](img/05-First_Steps-00.png) + +- Open the Ubuntu terminal. +- (It may show some output regarding the VS Code WSL extension being installed. + Just wait for this to complete.) +- Type `git clone https://github.com/RIOT-OS/RIOT` and confirm with the return-key +- This may take some time. Eventually, it will print `done.` when it completed +- Type `cd RIOT/examples/hello-world` and confirm with the return-key to enter + the folder `hello-world` example app in the RIOT repo +- Type `make` and confirm with the return key to build the app for the board + `native` + +> [!NOTE] +> The `native` board is a virtual board that will run an RIOT application as +> regular Linux process. This can be useful for testing or during development. +> The app should behave the same when run on real hardware. + +![The `hello-world` app running on the virtual `native` board](img/05-First_Steps-01.png) + +- Now run the application by executing `make term` +- The output should look similar to the screenshot above +- You can close the terminal by: + 1. Press and hold the `Ctrl`-key + 2. With the `Ctrl`-key still held, press the `C`-key + 3. Release both keys + +## Using VS Code for Development + +![Ubuntu terminal running `make compile-commands` in the `hello-world` app](img/06-Use_VS_Code-00.png) + +- If not already open, open the Ubuntu terminal +- Confirm that the terminal is pointed to the folder `~/RIOT/examples/hello-world` + - The blue part left of the prompt (the `$` sign in the terminal) shows + the current working directory for the terminal + - If the blue string is not `~/RIOT/examples/hello-world`, type + `cd ~/RIOT/examples/hello-world` to enter that path +- Inside `~/RIOT/examples/hello-world` run the command `make compile-commands` +- The output should look like above + +![Launching VS Code from Ubuntu](img/06-Use_VS_Code-01.png) + +- Navigate back to `~/RIOT` using the command `cd ~/RIOT` +- run `code .` to launch VS Code + - This will take a bit longer on the first launch +- Eventually, a VS Code Window should pop up that looks like this: + +![VS Code as opened from WSL](img/06-Use_VS_Code-02.png) + +1. Click on "Yes, I trust the authors" + +- Now, use the tree view in the left and open the `examples` folder +- Open the `hello-world` folder inside the `examples` folder +- Open the `main.c` file in the `hello-world` folder within `examples` +- The file should open and look like this: + +![VS Code asking to install C/C++ Extension](img/06-Use_VS_Code-03.png) + +1. Click on the "Install" button when prompted to install the C/C++ Extension. + +> [!NOTE] +> You can also install that extension via the extension marketplace just like +> the WSL extension was installed, if that pop up does not show up. + +![VS Code asking to configure RIOT as CMake project](img/06-Use_VS_Code-04.png) + +> [!WARNING] +> Do **NOT** configure RIOT as CMake project. VS Code will incorrectly detect +> RIOT as CMake project, because it contains external packages that indeed are +> using CMake. + +1. Click on "Not now" to not configure RIOT as CMake project +2. Click on "Never" to never ask again whether RIOT should be configured as + CMake project (not shown in screenshot) + +![IntelliSense showing that `RIOT_BOARD` is `"native"`](img/06-Use_VS_Code-05.png) + +- Confirm that when hovering over `RIOT_BOARD` in the source code, IntelliSense + shows that it expands to `"native"`. + +> [!NOTE] +> IntelliSense depends on information how to compile the source code to work +> correctly, which is provided in the file `compile_commands.json`. You can +> regenerate this file by running `make compile-commands` in the app you are +> working on. + +> [!WARNING] +> Re-run `make compile-commands` when: +> 1. You create, delete or rename source files +> 2. You change the set of modules or packages used +> 3. You have updated the RIOT repository +> 4. You are switching the board to compile for + + +![Compiling via the Terminal in VS Code](img/06-Use_VS_Code-06.png) + +- Extend the message to be printed, e.g. by adding a `puts("...");` statement + in the source code +- Save the modified source code (e.g. `Ctrl`+`S`) +- Open the integrated terminal by clicking on the terminal tab at the bottom +- Navigate to `~/RIOT/examples/hello-world` using `cd ~/RIOT/examples/hello-world` +- Run the `make` command to build the code +- Run make `make term` to launch the application +- The result should look like: + +![Running the app in VS Code](img/06-Use_VS_Code-07.png) + +Congratulations! You just compiled your first RIOT application. To run RIOT +on real hardware, proceed with the next to sections. + +## Installing `usbipd-win` + +![Release Page of usbipd-win](img/07-Install_USBIPd-01.png) + +0. Open the [release page of `usbipd-win`][usbipd-win-releases] +1. Download the installer (file extension `.msi`) of the most recent release + +[usbipd-win-releases]: https://github.com/dorssel/usbipd-win/releases + +![Download of usbipd-win completed](img/07-Install_USBIPd-02.png) + +Once the download is completed: + +1. Open the downloaded installer + +![Confirmation to open the installer](img/07-Install_USBIPd-03.png) + +1. Confirm that you indeed want to execute the installer by clicking "OK". + +![Setup of usbipd-win](img/07-Install_USBIPd-04.png) + +The setup of `usbipd-win` opens. + +1. Click on the "Install" button to proceed with the installation. + +![Confirmation of installation](img/07-Install_USBIPd-05.png) + +1. Confirm the installation by clicking on "Yes". + +![Completion of the usbipd-win setup](img/07-Install_USBIPd-06.png) + +Eventually, the setup will inform you of the completion of the installation. + +1. Click the "Close" button to acknowledge. + +## Attach a USB device to WSL + +> [!NOTE] +> Attaching a USB device to WSL needs to be repeated after any of the following +> happens: +> +> 1. Windows has been restarted (or hibernated) +> 2. WSL (the Ubuntu terminal window) has been restarted +> 3. The USB device has been lost (e.g. unplugging and plugging back in) + +> [!NOTE] +> You do not need to install the Windows USB drivers, Linux will use its own +> anyway. All supported board run on Linux out of the box without the need of +> drivers to be installed. + +![Running PowerShell as admin](img/08-Flash_Real_Hardware-00.png) + +1. Search for `powershell` in search field in the task bar +2. ***Right***-click on the search result "Windows PowerShell" +3. Select "Run as administrator" + +![Confirmation to run PowerShell as admin](img/08-Flash_Real_Hardware-01.png) + +1. Click on "Yes" to confirm running the PowerShell as admin + +![PowerShell terminal](img/08-Flash_Real_Hardware-02.png) + +1. Type the command `usbipd list` and confirm with the return-key +2. Identify the USB device to share. In this guide we use an ESP32 development + board, which almost all use an USB to UART bridge (here the CP2104). +3. Run `usbipd bin --busid `, but replace `` with the correct + BUSID. E.g. `2-5` for the CP2104 identified in step 2. +4. Run `usbipd attach --wsl --busid ` + - If an error (such as above in red) is shown that WSL is not running, just + start the Ubuntu terminal now and repeat (step 5.). If it worked the first + time, no need to run it again. + +> [!NOTE] +> If you have trouble identifying the USB device to attach, unplug before +> running `usbipd list`. Run it again with the USB device plugged in. The new +> entry in the list is the device you want to attach to WSL. + +## Flash an ESP32 Development Board + +After all of the previous sections are completed, we can finally flash some +real hardware. In this case, we use an `esp32-mh-et-live-minikit` development +board. The guide should mostly apply to all other boards as well. + +> [!NOTE] +> Some boards require extra steps to be flashed, such as pressing a button +> to enter a bootloader or attaching an external programmer. Refer to the +> documentation of the board to check if extra steps are required. + +This assumes that the USB UART bridge of the ESP32 development board has +been attached to WSL and VS Code has been launched from within WSL by running +`code .` inside the RIOT repository from the Ubuntu terminal. + +![VS Code in WSL](img/08-Flash_Real_Hardware-03.png) + +1. Open the `examples` folder +2. Open the `default` folder within `examples` +3. Open the `main.c` file in the `default` folder +4. Select the "Terminal" tab at the bottom +5. Enter `cd ~/RIOT/examples/default` to enter the `default` folder also in the terminal +6. Run `make BOARD=esp32-mh-et-live-minikit compile-commands` + - You can replace `esp32-mh-et-live-minikit` with the name of any other supported board + +> [!NOTE] +> Did you notice that IntelliSense did not find headers in `main.c` when you +> opened it? This should be fixed after the command in 6 has completed. + +![Flashing from VS Code](img/08-Flash_Real_Hardware-04.png) + +1. Now run `make BOARD=esp32-mh-et-live-minikit BUILD_IN_DOCKER=1 flash term` + +> [!NOTE] +> Tired of typing `BOARD=` and `BUILD_IN_DOCKER=1`? You can +> add those to the `Makefile` of your app or run +> `export BOARD=BUILD_IN_DOCKER=1` in the shell. The `export` will not persist +> needs to be repeated for every new terminal window. + +![Pulling docker image](img/08-Flash_Real_Hardware-05.png) + +When compiling with `BUILD_IN_DOCKER=1`, the toolchains distributed in the +[`riot/riotbuild`](https://hub.docker.com/r/riot/riotbuild/) docker image will +be used for compilation. This image contains toolchains for all supported RIOT +board and is extensively tested in our CI. + +The first time you build with `BUILD_IN_DOCKER=1`, the image is pulled +automatically. + +![Still pulling docker image](img/08-Flash_Real_Hardware-06.png) + +This may take a while ... + +![Building the firmware](img/08-Flash_Real_Hardware-07.png) + +... until eventually the docker image is pulled and the build will start. +Subsequent builds will no longer need to download the toolchain and be a lot +quicker. + +![Interacting with the firmware](img/08-Flash_Real_Hardware-08.png) + +After building and flashing the firmware has succeeded, a shell will open. + +1. Wait for the boot message to appear. + - The board may boot faster than your PC is able to connect to the serial. + If you see nothing after "Welcome to pyterm!" for 5 seconds, try hitting + the reset button on the board to boot it again. +2. You are now connected to the RIOT shell running on the board. Try running + the `help` command to get a list of commands supported by the board. +3. You can drop out of the RIOT serial by pressing `Ctrl` + `C` and return + to the Linux shell. + +## Known Issues + +### Flashing Fails with Programmers using HID + +The Linux Kernel in WSL currently has +[`CONFIG_USB_HIDDEV` disabled][wsl-hid-issue]. Hence, programmers using HID +as transport do not work for now. The (non-conclusive) list of affected +programmers is: + +- Atmel/Microchip eDBG +- Atmel/Microchip ICE +- Any ARM CMSIS DAP compatible programmers + +> [!NOTE] +> It is possible to install a native Windows flash application and invoke that +> from within WSL. + +The (non-conclusive) list of programmers that work with WSL out of the box is: + +- ST-Link (any version), including [cheap clones](https://www.aliexpress.com/wholesale?SearchText=ST-Link+V2) +- Segger J-Link, including the [J-Link EDU Mini](https://www.segger.com/products/debug-probes/j-link/models/j-link-edu-mini/) +- Any serial based bootloader (e.g. ESP boards, Arduino Bootloaders, ...) +- [Black Magic Probe](https://black-magic.org) +- [Jeff Probe](https://flirc.com/more/flirc-jeff-probe-bmp-jtag-black-magic-probe) +- Any other non HID USB programmer + + +[wsl-hid-issue]: https://github.com/microsoft/WSL/issues/10581 diff --git a/doc/guides/setup-windows/img/00-Install_Ubuntu-00.png b/doc/guides/setup-windows/img/00-Install_Ubuntu-00.png new file mode 100644 index 0000000000..78e27ac1b0 Binary files /dev/null and b/doc/guides/setup-windows/img/00-Install_Ubuntu-00.png differ diff --git a/doc/guides/setup-windows/img/00-Install_Ubuntu-01.png b/doc/guides/setup-windows/img/00-Install_Ubuntu-01.png new file mode 100644 index 0000000000..35f2b19de1 Binary files /dev/null and b/doc/guides/setup-windows/img/00-Install_Ubuntu-01.png differ diff --git a/doc/guides/setup-windows/img/00-Install_Ubuntu-02.png b/doc/guides/setup-windows/img/00-Install_Ubuntu-02.png new file mode 100644 index 0000000000..56f53fdef3 Binary files /dev/null and b/doc/guides/setup-windows/img/00-Install_Ubuntu-02.png differ diff --git a/doc/guides/setup-windows/img/00-Install_Ubuntu-03.png b/doc/guides/setup-windows/img/00-Install_Ubuntu-03.png new file mode 100644 index 0000000000..2cbe37d7a4 Binary files /dev/null and b/doc/guides/setup-windows/img/00-Install_Ubuntu-03.png differ diff --git a/doc/guides/setup-windows/img/00-Install_Ubuntu-04.png b/doc/guides/setup-windows/img/00-Install_Ubuntu-04.png new file mode 100644 index 0000000000..df9c909e45 Binary files /dev/null and b/doc/guides/setup-windows/img/00-Install_Ubuntu-04.png differ diff --git a/doc/guides/setup-windows/img/01-Install_WSL-00.png b/doc/guides/setup-windows/img/01-Install_WSL-00.png new file mode 100644 index 0000000000..e9f8507fa7 Binary files /dev/null and b/doc/guides/setup-windows/img/01-Install_WSL-00.png differ diff --git a/doc/guides/setup-windows/img/01-Install_WSL-01.png b/doc/guides/setup-windows/img/01-Install_WSL-01.png new file mode 100644 index 0000000000..cc7cde8e20 Binary files /dev/null and b/doc/guides/setup-windows/img/01-Install_WSL-01.png differ diff --git a/doc/guides/setup-windows/img/01-Install_WSL-02.png b/doc/guides/setup-windows/img/01-Install_WSL-02.png new file mode 100644 index 0000000000..b1cff6edc9 Binary files /dev/null and b/doc/guides/setup-windows/img/01-Install_WSL-02.png differ diff --git a/doc/guides/setup-windows/img/01-Install_WSL-03.png b/doc/guides/setup-windows/img/01-Install_WSL-03.png new file mode 100644 index 0000000000..3ba6360dda Binary files /dev/null and b/doc/guides/setup-windows/img/01-Install_WSL-03.png differ diff --git a/doc/guides/setup-windows/img/01-Install_WSL-04.png b/doc/guides/setup-windows/img/01-Install_WSL-04.png new file mode 100644 index 0000000000..413606234c Binary files /dev/null and b/doc/guides/setup-windows/img/01-Install_WSL-04.png differ diff --git a/doc/guides/setup-windows/img/02-Setup_Ubuntu-00.png b/doc/guides/setup-windows/img/02-Setup_Ubuntu-00.png new file mode 100644 index 0000000000..f18d3ff464 Binary files /dev/null and b/doc/guides/setup-windows/img/02-Setup_Ubuntu-00.png differ diff --git a/doc/guides/setup-windows/img/02-Setup_Ubuntu-01.png b/doc/guides/setup-windows/img/02-Setup_Ubuntu-01.png new file mode 100644 index 0000000000..918b4cab1a Binary files /dev/null and b/doc/guides/setup-windows/img/02-Setup_Ubuntu-01.png differ diff --git a/doc/guides/setup-windows/img/02-Setup_Ubuntu-02.png b/doc/guides/setup-windows/img/02-Setup_Ubuntu-02.png new file mode 100644 index 0000000000..ba7bd6996f Binary files /dev/null and b/doc/guides/setup-windows/img/02-Setup_Ubuntu-02.png differ diff --git a/doc/guides/setup-windows/img/02-Setup_Ubuntu-03.png b/doc/guides/setup-windows/img/02-Setup_Ubuntu-03.png new file mode 100644 index 0000000000..34ada15ebb Binary files /dev/null and b/doc/guides/setup-windows/img/02-Setup_Ubuntu-03.png differ diff --git a/doc/guides/setup-windows/img/02-Setup_Ubuntu-04.png b/doc/guides/setup-windows/img/02-Setup_Ubuntu-04.png new file mode 100644 index 0000000000..b7e1c973db Binary files /dev/null and b/doc/guides/setup-windows/img/02-Setup_Ubuntu-04.png differ diff --git a/doc/guides/setup-windows/img/02-Setup_Ubuntu-05.png b/doc/guides/setup-windows/img/02-Setup_Ubuntu-05.png new file mode 100644 index 0000000000..cd187cc6f2 Binary files /dev/null and b/doc/guides/setup-windows/img/02-Setup_Ubuntu-05.png differ diff --git a/doc/guides/setup-windows/img/03-Install_Base_Packages-00.png b/doc/guides/setup-windows/img/03-Install_Base_Packages-00.png new file mode 100644 index 0000000000..80f07d4c48 Binary files /dev/null and b/doc/guides/setup-windows/img/03-Install_Base_Packages-00.png differ diff --git a/doc/guides/setup-windows/img/03-Install_Base_Packages-01.png b/doc/guides/setup-windows/img/03-Install_Base_Packages-01.png new file mode 100644 index 0000000000..5a8b39130f Binary files /dev/null and b/doc/guides/setup-windows/img/03-Install_Base_Packages-01.png differ diff --git a/doc/guides/setup-windows/img/03-Install_Base_Packages-02.png b/doc/guides/setup-windows/img/03-Install_Base_Packages-02.png new file mode 100644 index 0000000000..201e859a98 Binary files /dev/null and b/doc/guides/setup-windows/img/03-Install_Base_Packages-02.png differ diff --git a/doc/guides/setup-windows/img/04-Install_VS_Code-00.png b/doc/guides/setup-windows/img/04-Install_VS_Code-00.png new file mode 100644 index 0000000000..697d6c941f Binary files /dev/null and b/doc/guides/setup-windows/img/04-Install_VS_Code-00.png differ diff --git a/doc/guides/setup-windows/img/04-Install_VS_Code-01.png b/doc/guides/setup-windows/img/04-Install_VS_Code-01.png new file mode 100644 index 0000000000..dde5dc8a24 Binary files /dev/null and b/doc/guides/setup-windows/img/04-Install_VS_Code-01.png differ diff --git a/doc/guides/setup-windows/img/04-Install_VS_Code-02.png b/doc/guides/setup-windows/img/04-Install_VS_Code-02.png new file mode 100644 index 0000000000..5f781b04f1 Binary files /dev/null and b/doc/guides/setup-windows/img/04-Install_VS_Code-02.png differ diff --git a/doc/guides/setup-windows/img/04-Install_VS_Code-03.png b/doc/guides/setup-windows/img/04-Install_VS_Code-03.png new file mode 100644 index 0000000000..3e25485d8e Binary files /dev/null and b/doc/guides/setup-windows/img/04-Install_VS_Code-03.png differ diff --git a/doc/guides/setup-windows/img/04-Install_VS_Code-04.png b/doc/guides/setup-windows/img/04-Install_VS_Code-04.png new file mode 100644 index 0000000000..23901dfeee Binary files /dev/null and b/doc/guides/setup-windows/img/04-Install_VS_Code-04.png differ diff --git a/doc/guides/setup-windows/img/05-First_Steps-00.png b/doc/guides/setup-windows/img/05-First_Steps-00.png new file mode 100644 index 0000000000..7e94e69a5a Binary files /dev/null and b/doc/guides/setup-windows/img/05-First_Steps-00.png differ diff --git a/doc/guides/setup-windows/img/05-First_Steps-01.png b/doc/guides/setup-windows/img/05-First_Steps-01.png new file mode 100644 index 0000000000..ca6a8bab3d Binary files /dev/null and b/doc/guides/setup-windows/img/05-First_Steps-01.png differ diff --git a/doc/guides/setup-windows/img/06-Use_VS_Code-00.png b/doc/guides/setup-windows/img/06-Use_VS_Code-00.png new file mode 100644 index 0000000000..11fa6f91a3 Binary files /dev/null and b/doc/guides/setup-windows/img/06-Use_VS_Code-00.png differ diff --git a/doc/guides/setup-windows/img/06-Use_VS_Code-01.png b/doc/guides/setup-windows/img/06-Use_VS_Code-01.png new file mode 100644 index 0000000000..694f630322 Binary files /dev/null and b/doc/guides/setup-windows/img/06-Use_VS_Code-01.png differ diff --git a/doc/guides/setup-windows/img/06-Use_VS_Code-02.png b/doc/guides/setup-windows/img/06-Use_VS_Code-02.png new file mode 100644 index 0000000000..681f1d2d82 Binary files /dev/null and b/doc/guides/setup-windows/img/06-Use_VS_Code-02.png differ diff --git a/doc/guides/setup-windows/img/06-Use_VS_Code-03.png b/doc/guides/setup-windows/img/06-Use_VS_Code-03.png new file mode 100644 index 0000000000..1a0a59c3f5 Binary files /dev/null and b/doc/guides/setup-windows/img/06-Use_VS_Code-03.png differ diff --git a/doc/guides/setup-windows/img/06-Use_VS_Code-04.png b/doc/guides/setup-windows/img/06-Use_VS_Code-04.png new file mode 100644 index 0000000000..67e4aa5f99 Binary files /dev/null and b/doc/guides/setup-windows/img/06-Use_VS_Code-04.png differ diff --git a/doc/guides/setup-windows/img/06-Use_VS_Code-05.png b/doc/guides/setup-windows/img/06-Use_VS_Code-05.png new file mode 100644 index 0000000000..f0e300ca41 Binary files /dev/null and b/doc/guides/setup-windows/img/06-Use_VS_Code-05.png differ diff --git a/doc/guides/setup-windows/img/06-Use_VS_Code-06.png b/doc/guides/setup-windows/img/06-Use_VS_Code-06.png new file mode 100644 index 0000000000..db2602737e Binary files /dev/null and b/doc/guides/setup-windows/img/06-Use_VS_Code-06.png differ diff --git a/doc/guides/setup-windows/img/06-Use_VS_Code-07.png b/doc/guides/setup-windows/img/06-Use_VS_Code-07.png new file mode 100644 index 0000000000..885ba5f32f Binary files /dev/null and b/doc/guides/setup-windows/img/06-Use_VS_Code-07.png differ diff --git a/doc/guides/setup-windows/img/07-Install_USBIPd-00.png b/doc/guides/setup-windows/img/07-Install_USBIPd-00.png new file mode 100644 index 0000000000..292e06dc20 Binary files /dev/null and b/doc/guides/setup-windows/img/07-Install_USBIPd-00.png differ diff --git a/doc/guides/setup-windows/img/07-Install_USBIPd-01.png b/doc/guides/setup-windows/img/07-Install_USBIPd-01.png new file mode 100644 index 0000000000..afb0a9812b Binary files /dev/null and b/doc/guides/setup-windows/img/07-Install_USBIPd-01.png differ diff --git a/doc/guides/setup-windows/img/07-Install_USBIPd-02.png b/doc/guides/setup-windows/img/07-Install_USBIPd-02.png new file mode 100644 index 0000000000..3487f3ce04 Binary files /dev/null and b/doc/guides/setup-windows/img/07-Install_USBIPd-02.png differ diff --git a/doc/guides/setup-windows/img/07-Install_USBIPd-03.png b/doc/guides/setup-windows/img/07-Install_USBIPd-03.png new file mode 100644 index 0000000000..d16ac49666 Binary files /dev/null and b/doc/guides/setup-windows/img/07-Install_USBIPd-03.png differ diff --git a/doc/guides/setup-windows/img/07-Install_USBIPd-04.png b/doc/guides/setup-windows/img/07-Install_USBIPd-04.png new file mode 100644 index 0000000000..d44dfaad92 Binary files /dev/null and b/doc/guides/setup-windows/img/07-Install_USBIPd-04.png differ diff --git a/doc/guides/setup-windows/img/07-Install_USBIPd-05.png b/doc/guides/setup-windows/img/07-Install_USBIPd-05.png new file mode 100644 index 0000000000..828c1788f8 Binary files /dev/null and b/doc/guides/setup-windows/img/07-Install_USBIPd-05.png differ diff --git a/doc/guides/setup-windows/img/07-Install_USBIPd-06.png b/doc/guides/setup-windows/img/07-Install_USBIPd-06.png new file mode 100644 index 0000000000..ac06ecbd6c Binary files /dev/null and b/doc/guides/setup-windows/img/07-Install_USBIPd-06.png differ diff --git a/doc/guides/setup-windows/img/08-Flash_Real_Hardware-00.png b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-00.png new file mode 100644 index 0000000000..8c6157e99f Binary files /dev/null and b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-00.png differ diff --git a/doc/guides/setup-windows/img/08-Flash_Real_Hardware-01.png b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-01.png new file mode 100644 index 0000000000..cb0cae0381 Binary files /dev/null and b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-01.png differ diff --git a/doc/guides/setup-windows/img/08-Flash_Real_Hardware-02.png b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-02.png new file mode 100644 index 0000000000..f02bffb68c Binary files /dev/null and b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-02.png differ diff --git a/doc/guides/setup-windows/img/08-Flash_Real_Hardware-03.png b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-03.png new file mode 100644 index 0000000000..62f32bcda6 Binary files /dev/null and b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-03.png differ diff --git a/doc/guides/setup-windows/img/08-Flash_Real_Hardware-04.png b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-04.png new file mode 100644 index 0000000000..4f9d4f91f4 Binary files /dev/null and b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-04.png differ diff --git a/doc/guides/setup-windows/img/08-Flash_Real_Hardware-05.png b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-05.png new file mode 100644 index 0000000000..937943f341 Binary files /dev/null and b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-05.png differ diff --git a/doc/guides/setup-windows/img/08-Flash_Real_Hardware-06.png b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-06.png new file mode 100644 index 0000000000..077d4657ac Binary files /dev/null and b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-06.png differ diff --git a/doc/guides/setup-windows/img/08-Flash_Real_Hardware-07.png b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-07.png new file mode 100644 index 0000000000..497a692d6f Binary files /dev/null and b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-07.png differ diff --git a/doc/guides/setup-windows/img/08-Flash_Real_Hardware-08.png b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-08.png new file mode 100644 index 0000000000..f6ebab92d1 Binary files /dev/null and b/doc/guides/setup-windows/img/08-Flash_Real_Hardware-08.png differ diff --git a/doc/guides/setup-windows/img/inkscape/00-Install_Ubuntu-00.svg b/doc/guides/setup-windows/img/inkscape/00-Install_Ubuntu-00.svg new file mode 100644 index 0000000000..637f9e2b2f --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/00-Install_Ubuntu-00.svg @@ -0,0 +1,136 @@ + + + + + + + + + + + + 1 + + + + + 2 + + + + + 3 + + + diff --git a/doc/guides/setup-windows/img/inkscape/00-Install_Ubuntu-01.svg b/doc/guides/setup-windows/img/inkscape/00-Install_Ubuntu-01.svg new file mode 100644 index 0000000000..94ecab4904 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/00-Install_Ubuntu-01.svg @@ -0,0 +1,80 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/00-Install_Ubuntu-03.svg b/doc/guides/setup-windows/img/inkscape/00-Install_Ubuntu-03.svg new file mode 100644 index 0000000000..290dfead11 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/00-Install_Ubuntu-03.svg @@ -0,0 +1,80 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/01-Install_WSL-00.svg b/doc/guides/setup-windows/img/inkscape/01-Install_WSL-00.svg new file mode 100644 index 0000000000..93d29b2718 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/01-Install_WSL-00.svg @@ -0,0 +1,129 @@ + + + + + + + + + + + 1 + + + + + 2 + + + + + 3 + + diff --git a/doc/guides/setup-windows/img/inkscape/01-Install_WSL-01.svg b/doc/guides/setup-windows/img/inkscape/01-Install_WSL-01.svg new file mode 100644 index 0000000000..b83e149b29 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/01-Install_WSL-01.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/02-Setup_Ubuntu-01.svg b/doc/guides/setup-windows/img/inkscape/02-Setup_Ubuntu-01.svg new file mode 100644 index 0000000000..80993cb68e --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/02-Setup_Ubuntu-01.svg @@ -0,0 +1,107 @@ + + + + + + + + + + + + 1 + + + + + 2 + + + diff --git a/doc/guides/setup-windows/img/inkscape/04-Install_VS_Code-00.svg b/doc/guides/setup-windows/img/inkscape/04-Install_VS_Code-00.svg new file mode 100644 index 0000000000..d94a0f7fbd --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/04-Install_VS_Code-00.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + 1 + + + + + 2 + + + + + 4 + + + diff --git a/doc/guides/setup-windows/img/inkscape/04-Install_VS_Code-05.svg b/doc/guides/setup-windows/img/inkscape/04-Install_VS_Code-05.svg new file mode 100644 index 0000000000..60aa694e9e --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/04-Install_VS_Code-05.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + 1 + + + + + 2 + + + + + 3 + + + diff --git a/doc/guides/setup-windows/img/inkscape/06-Use_VS_Code-02.svg b/doc/guides/setup-windows/img/inkscape/06-Use_VS_Code-02.svg new file mode 100644 index 0000000000..20ae540ba3 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/06-Use_VS_Code-02.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/06-Use_VS_Code-03.svg b/doc/guides/setup-windows/img/inkscape/06-Use_VS_Code-03.svg new file mode 100644 index 0000000000..16484e0c47 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/06-Use_VS_Code-03.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/06-Use_VS_Code-04.svg b/doc/guides/setup-windows/img/inkscape/06-Use_VS_Code-04.svg new file mode 100644 index 0000000000..f98b3e7025 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/06-Use_VS_Code-04.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-00.svg b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-00.svg new file mode 100644 index 0000000000..425d755fa4 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-00.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-01.svg b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-01.svg new file mode 100644 index 0000000000..a3ce6cf870 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-01.svg @@ -0,0 +1,76 @@ + + + + + + + + + + + 1 + + diff --git a/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-02.svg b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-02.svg new file mode 100644 index 0000000000..946b3c5e96 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-02.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-03.svg b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-03.svg new file mode 100644 index 0000000000..b584fd56c1 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-03.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-04.svg b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-04.svg new file mode 100644 index 0000000000..60f43a47e6 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-04.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-05.svg b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-05.svg new file mode 100644 index 0000000000..a7a9327be5 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-05.svg @@ -0,0 +1,80 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-06.svg b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-06.svg new file mode 100644 index 0000000000..d6f26ca646 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/07-Install_USBIPd-06.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-00.svg b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-00.svg new file mode 100644 index 0000000000..1239ec3847 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-00.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + 1 + + + + + 2 + + + + + 3 + + + diff --git a/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-01.svg b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-01.svg new file mode 100644 index 0000000000..2705b5b5af --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-01.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-02.svg b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-02.svg new file mode 100644 index 0000000000..88a2e3745e --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-02.svg @@ -0,0 +1,198 @@ + + + + + + + + + + + + 1 + + + + + 2 + + + + + 3 + + + + + 4 + + + + + + 5 + + + + diff --git a/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-03.svg b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-03.svg new file mode 100644 index 0000000000..305ec227a8 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-03.svg @@ -0,0 +1,223 @@ + + + + + + + + + + + + 1 + + + + + 2 + + + + + 3 + + + + + 4 + + + + + 5 + + + + + 6 + + + diff --git a/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-04.svg b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-04.svg new file mode 100644 index 0000000000..5c53d3687f --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-04.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + 1 + + + diff --git a/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-08.svg b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-08.svg new file mode 100644 index 0000000000..bf7fc225a6 --- /dev/null +++ b/doc/guides/setup-windows/img/inkscape/08-Flash_Real_Hardware-08.svg @@ -0,0 +1,107 @@ + + + + + + + + + + + + 1 + + + + + 2 + + +