Windows VSCode compile instructions not working
Summary:
I tried to "stupidly" follow the "Compiling Inkscape on Windows With VSCode" instructions https://gitlab.com/inkscape/inkscape/-/blob/master/doc/vscode/readme.md but they do not work and the details are not always clear.
Steps to reproduce:
- Set up clean Windows (in my case: Windows 10 VM)
- Follow the instructions word-by-word from here https://gitlab.com/inkscape/inkscape/-/blob/master/doc/vscode/readme.md
What happened?
There are several problems.
- Commands for Ninja install / CMake are not found in the command palette under the suggested search term, they are much more hidden (
Ctrl-Shift-P,Tasks: Run Tasks[Enter]Ninja Install) - CMake command does not run,
cmake not found - Build command (Ctrl Shift B) does not run,
ninja not found - Details of some formulations are confusing. Some examples (not complete):
- It says "Follow these sections of the tutorial for compiling Inkscape on Windows: 1. Compiling Inkscape on Windows". However, "Compiling Inkscape on Windows" is the heading of the complete tutorial, which is probably not the intended meaning.)
- "Add the following" regarding JSON, not clear if the user doesn't know JSON syntax and the expected data format (is an outer brace needed)?
- At this point you can follow the commands from the compilation tutorial. --> Which commands?
- The commands from the compilation tutorial are only recommended (not mandatory). Later it is assumed that the build directory exists (which is only created by these commands). Maybe change the tutorial so that the user first follows the normal commandline tutorial and then later sets up VSCode?
- --> The whole text needs to be tried step by step (without thinking) and details adjusted accordingly.
- Task JSON files use the wrong MSYSTEM flavor (MINGW64, correct would be UCRT64)
- VSCode shows various suggestions / info messages regarding CMake, Git installation etc.; we should tell the user what to click in these messages (probably: Install Git for Windows but do not click on anything CMake?)
- there may be more issues; I could not get it to work.
What should have happened?
The instructions should just work if you follow them word by word without thinking.
Version info
Inkscape master as of 2025-06-09.
/cc @WeatherWonders
Edited by Max Gaukler