Skip to content

Commit ddc9202

Browse files
committed
docs(README): require wrapper generation
- Remove pre-generated wrappers claim; generator required per Qt version. - Document default output (../generated_cpp) and PYTHONQT_GENERATED_PATH. - Add qmake toggles (generator_only/exclude_generator)
1 parent 5b18910 commit ddc9202

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,9 @@ see https://github.com/danmar/simplecpp. It is licensed under the `0BSDL` licens
3131
see the `LICENSE` file in the generator/simplecpp directory.
3232
Copyright (C) 2016-2023 simplecpp team
3333

34-
The generated wrappers are pre-generated and checked-in, so you only
35-
need to build and run the generator when you want to build additional wrappers
36-
or you want to upgrade/downgrade to another Qt version, but this requires
37-
updating the typesystems as well.
34+
Wrappers are **not** shipped pre-generated. You must run the generator to
35+
create wrappers for your Qt version (recommended). The repository may keep a
36+
single example tree (e.g., `generated_cpp_515`) only as a reference.
3837

3938
# Building
4039

@@ -93,6 +92,21 @@ First, you need to set a couple of environment variables, which depend on your P
9392

9493
`<generator-executable> qtscript_masterinclude.h build_all.txt`
9594

95+
96+
**Output location:** by default the generator emits to `../generated_cpp`
97+
(relative to the build). You can override this with:
98+
99+
```
100+
qmake PYTHONQT_GENERATED_PATH=/abs/path/to/generated_cpp
101+
```
102+
103+
#### qmake toggles (optional)
104+
105+
* `CONFIG+=generator_only`: build only the wrapper generator.
106+
* `CONFIG+=exclude_generator`: build everything **except** the generator.
107+
108+
Use these to (1) build the generator, (2) run it to produce `generated_cpp`, then (3) build the rest without rebuilding the generator.
109+
96110
### PythonQt Runtime
97111

98112
Next, we need the PythonQt runtime.

0 commit comments

Comments
 (0)