mirror of
https://github.com/RetroPortingToolKit/psxrecomp
synced 2026-10-28 10:59:16 -04:00
Matthew Stanley
77d036bfb6
Make the repo approachable for outside contributors and an IDE integrator:
- New contributor docs:
- docs/EXECUTION_MODEL.md — semi-technical tour of the static / native-overlay
/ interpreter execution model and how coverage gaps get plugged.
- docs/ARCHITECTURE.md — component-level view (recompiler, runtime, LLE+HLE
BIOS, overlay backend static->gcc->tcc, renderers, oracle model).
- docs/BUILDING.md — accurate dependency table, per-platform prereqs, build
steps, and the submodule + local-junction framework-linking setup.
- CONTRIBUTING.md — distilled core rules, verification expectations, PR flow.
- Declutter root: move ~14 internal dev-logs into docs/internal/ (history
preserved via rename) with an index README; repoint CLAUDE.md references.
- README: correct build recipe, LLE+HLE + overlay-backend summary, links to the
new docs.
- code_provider.c: update the stale backend comment to the real static->gcc->tcc
resolution (dead SLJIT.md reference removed).
- config_schema.md: drop the obsolete "once Phase A2/A3 ships --config" note.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
43 lines
2.1 KiB
Markdown
43 lines
2.1 KiB
Markdown
# Internal dev-logs & design notes
|
||
|
||
These are the working design documents and burn-down logs the project was built
|
||
from. They are **historical/working notes**, not contributor onboarding docs —
|
||
they capture decisions, phased plans, and deep subsystem investigations in the
|
||
order they happened, and some sections are superseded by later ones.
|
||
|
||
If you're new here, start with the top-level [`README.md`](../../README.md),
|
||
then [`docs/ARCHITECTURE.md`](../ARCHITECTURE.md),
|
||
[`docs/EXECUTION_MODEL.md`](../EXECUTION_MODEL.md),
|
||
[`docs/BUILDING.md`](../BUILDING.md), and
|
||
[`CONTRIBUTING.md`](../../CONTRIBUTING.md). Come here when you need the *why*
|
||
behind a specific subsystem.
|
||
|
||
## Plans & roadmap
|
||
- [`PLAN.md`](PLAN.md) — the original phased build plan (P1–P6).
|
||
- [`FAITHFUL_TIMING_PLAN.md`](FAITHFUL_TIMING_PLAN.md) — the authoritative
|
||
cycle-accuracy north-star plan and status log.
|
||
- [`FIRST_MILESTONE.md`](FIRST_MILESTONE.md) — the first-boot milestone gate.
|
||
- [`STUBS_TO_FIX.md`](STUBS_TO_FIX.md) — hardware-stub burn-down (pre-game gate).
|
||
|
||
## Cycle accuracy & timing
|
||
- [`PRECISE_IRQ_SLICE.md`](PRECISE_IRQ_SLICE.md) — exact-instruction IRQ delivery.
|
||
- [`CYCLE_MODEL_BEETLE.md`](CYCLE_MODEL_BEETLE.md) — the Beetle-derived cycle model.
|
||
- [`ACCURACY_BURNDOWN.md`](ACCURACY_BURNDOWN.md) — full accuracy burn-down across
|
||
all axes (semantics, cycle, IRQ, MMIO, peripherals, determinism).
|
||
- [`COSIM_ORACLE.md`](COSIM_ORACLE.md) — the first-divergence co-sim oracle.
|
||
|
||
## BIOS / scheduler
|
||
- [`HLE_SCHEDULER_CARVEOUT_PLAN.md`](HLE_SCHEDULER_CARVEOUT_PLAN.md) — the
|
||
cooperative-thread scheduler HLE carve-out.
|
||
- [`WEDGE_load4_shell_rootcause.md`](WEDGE_load4_shell_rootcause.md) — a specific
|
||
boot-shell wedge root-cause writeup.
|
||
|
||
## Renderer / widescreen
|
||
- [`GL_RENDERER_HANDOFF.md`](GL_RENDERER_HANDOFF.md) — OpenGL renderer design.
|
||
- [`NATIVE_WIDE_PLAN.md`](NATIVE_WIDE_PLAN.md) — native-wide 16:9 (GTE FOV) plan.
|
||
- [`BACKDROP_PRELOAD.md`](BACKDROP_PRELOAD.md) — widescreen backdrop preload.
|
||
|
||
## Overlay cache internals
|
||
- [`SLJIT_PERSIST_CACHE.md`](SLJIT_PERSIST_CACHE.md) — persisted overlay-shard
|
||
cache design.
|