DAER/visualisation-marsh
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add Windows instructions to README

Browse source
This commit is contained in:
Marek S. Łukasiewicz 2025-01-31 14:20:53 +01:00
parent 231b639901
commit 17190e20b8
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -14,6 +14,8 @@ git submodule update --init --recursive
Using Godot v4.4.beta1.official [d33da79d3](https://github.com/godotengine/godot/commit/d33da79d3f8fe84be2521d25b9ba8e440cf25a88). Using Godot v4.4.beta1.official [d33da79d3](https://github.com/godotengine/godot/commit/d33da79d3f8fe84be2521d25b9ba8e440cf25a88).
Install SCons with `pipx install scons`. Install SCons with `pipx install scons`.
You will need a C++ compiler, you might have one already on Linux, see below for Windows, otherwise in [Godot documentation](https://docs.godotengine.org/en/stable/contributing/development/compiling/index.html).
For updating MAVLink generator, you additionally `pip install future`. For updating MAVLink generator, you additionally `pip install future`.
It is recommended to install any packages in a [virtual environment](https://docs.python.org/3/library/venv.html), for example: It is recommended to install any packages in a [virtual environment](https://docs.python.org/3/library/venv.html), for example:
@ -31,6 +33,12 @@ scons compile_commands # after modifying SConstruct
python update_mavlink.py # after updating MAVLink dialect python update_mavlink.py # after updating MAVLink dialect
``` ```
### Windows setup
The most convenient way of getting a C++ compiler is via the LLVM-MinGW project (by the way, it optimizes the binary more).
Download the `llvm-mingw-...-msvcrt-x86_64.zip` from the [Releases page](https://github.com/mstorsjo/llvm-mingw/releases).
Unzip the archive to some location you like, and add its `bin` folder to `Path` using the "Edit environment variables for your account" program.
### Build ### Build
To build the GDExtension binary run SCons in the repository root, the default arguments have been added to the file. To build the GDExtension binary run SCons in the repository root, the default arguments have been added to the file.
@ -38,3 +46,9 @@ To build the GDExtension binary run SCons in the repository root, the default ar
```sh ```sh
scons scons
``` ```
When building for Windows with MinGW-LLVM, you need to [select this compiler](https://docs.godotengine.org/en/stable/contributing/development/compiling/compiling_for_windows.html#selecting-a-compiler):
```powershell
scons platform=windows use_mingw=yes use_llvm=yes
```