Skip to content

EffectCraft: An open-source motion graphics and compositing tool written by scratch in pure Rust

Merge main into fix/windows-gnu-import-libs

tylerjenningsw4c4421aa1385
diff --cc CONTRIBUTING.md
index 5f36bc5cb,74d946f01..840f29ed6
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@@ -13,44 -29,14 +29,52 @@@ cargo test --workspac
cargo xtask ci # what every commit must pass
```
+ The default `dev` profile keeps debug info to line tables: builds are fast and panics/backtraces
+ still name the file and line, but a debugger cannot show local variables. For an interactive
+ debugger session use the `dev-full` profile, which is the same build with full debug info:
+
+ ```sh
+ cargo run --profile dev-full -p effectcraft -- --demo
+ ```
+
+### Windows
+
+The MSVC toolchain, rustup's default on Windows, is what the releases use: with the Visual Studio
+C++ build tools installed, the commands above work as they are.
+
+The GNU toolchain (`x86_64-pc-windows-gnu`) needs a current mingw-w64 GCC and binutils first on
+`PATH`. They provide the linker and the Windows import libraries, such as `libshlwapi.a` for
+opening links from the app. With [MSYS2](https://www.msys2.org/):
+
+```powershell
+C:\msys64\usr\bin\pacman.exe -S --needed mingw-w64-x86_64-gcc
+$env:PATH = "C:\msys64\mingw64\bin;$env:PATH"
+cargo +stable-x86_64-pc-windows-gnu run -p effectcraft -- --demo
+```
+
+An older MinGW earlier on `PATH` can break the build: CodeBlocks' GCC 8.1 fails to link
+`boa_engine` ([#1882](https://github.com/storytold/effectcraft/issues/1882)).
+
+Rust's bundled LLD and self-contained libraries don't include every import library EffectCraft
+needs, so on their own they stop with `unable to find library -lshlwapi`
+([#1886](https://github.com/storytold/effectcraft/issues/1886)). To link that way, copy
+mingw-w64's `libshlwapi.a` into a folder of its own and add that folder to the search path in your
+own Cargo config (`%USERPROFILE%\.cargo\config.toml`). Don't add all of mingw-w64's `lib` folder:
+its C runtime clashes with Rust's bundled one (`undefined symbol: DllEntryPoint`).
+
+```powershell
+New-Item -ItemType Directory -Force C:\gnu-import-libs
+Copy-Item C:\msys64\mingw64\lib\libshlwapi.a C:\gnu-import-libs\
+```
+
+```toml
+[target.x86_64-pc-windows-gnu]
+linker = "rust-lld"
+rustflags = ["-C", "link-self-contained=yes", "-L", "native=C:/gnu-import-libs"]
+```
+
+The `Windows toolchains` workflow builds the app and the CLI each of these three ways every night.
+
## Ground rules
- **Clean room.** Work from After Effects' public documentation and its observable behaviour only.