Skip to content

Commit cf4f853

Browse files
committed
docs: document compiler prerequisite for default tests
1 parent 8044159 commit cf4f853

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,23 @@ You need:
1818

1919
- Git and [uv](https://docs.astral.sh/uv/)
2020
- Python 3.11 or newer
21+
- A system C compiler/toolchain that provides `cc` for the native-overlay tests
2122
- ffmpeg and ffprobe on `PATH` for the test suite
2223
- Docker with Compose v2 only when working on the Airflow runtime integration
2324
- [lychee](https://github.com/lycheeverse/lychee) when editing Markdown links
2425

26+
`uv sync --locked` installs the Python-side native-build dependencies, including
27+
Cython and setuptools, but it cannot install the system compiler they invoke.
28+
Before running the default suite, confirm that a compiler is available:
29+
30+
```bash
31+
command -v cc
32+
```
33+
34+
On Ubuntu (including WSL2), install the toolchain with
35+
`sudo apt-get install build-essential` if that command prints nothing. On
36+
macOS, install the Xcode Command Line Tools with `xcode-select --install`.
37+
2538
## Platform support
2639

2740
Linux and macOS both work for native development. CI runs on Linux only, so

0 commit comments

Comments
 (0)