Skip to content

Docs: examples/README — phpc/vm/aot run matrix per example folder #262

@PurHur

Description

@PurHur

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions