Problem
examples/README.md still describes only bin/vm.php / bin/compile.php -l and an outdated benchmark table (001/002 missing from the generated table). Contributors following README.md quick start use phpc serve, phpc build, and phpc lint, but the examples folder docs do not map which example runs in which mode.
Goal
Each examples/00x-*/ folder has a short run matrix in examples/README.md:
| Example |
VM |
JIT |
AOT build |
AOT runtime notes |
| 000-HelloWorld |
✅ |
✅ |
optional |
no superglobals |
| 001-SimpleWeb |
✅ -q/env |
✅ |
✅ |
runtime QUERY_STRING / POST (#201, #257) |
| 002-StaticWeb |
✅ |
✅ |
✅ recommended |
no superglobals — #247 execute smoke |
Scope
Acceptance criteria
A new contributor can run all three shipped examples without reading root README.md first.
Verification
Docs-only PR; reviewer runs:
./phpc lint examples/001-SimpleWeb/example.php
make web-smoke
Related
Problem
examples/README.mdstill describes onlybin/vm.php/bin/compile.php -land an outdated benchmark table (001/002 missing from the generated table). Contributors followingREADME.mdquick start usephpc serve,phpc build, andphpc lint, but the examples folder docs do not map which example runs in which mode.Goal
Each
examples/00x-*/folder has a short run matrix inexamples/README.md:-q/envQUERY_STRING/ POST (#201, #257)Scope
./phpc lint,./phpc serve,phpc build,phpc serve --aot)test/unit/ExamplesCompileTest.php(Testing: Example compile gate (VM run + AOT -l for all examples/*.php) #203, Testing: phpc lint gate for shipped examples in CI #243, Testing: ExamplesCompileTest AOT execute smoke (002-StaticWeb build + run) #247)make test-docker/./script/docker-ci-local.shscript/rebuild-examples.phpwhen AOT: Re-enable examples/001-SimpleWeb in benchmark table with runtime GET #60 landsAcceptance criteria
A new contributor can run all three shipped examples without reading root
README.mdfirst.Verification
Docs-only PR; reviewer runs:
Related