diff --git a/AGENTS.md b/AGENTS.md index 30a29a68..61c01c21 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -111,361 +111,9 @@ When the user requests a durable behavior change, record it here or in the relev - `modules_tcl8/`, `modules_tcl9/` — Tcl version-specific build output targets - `lib_tcl8/`, `lib_tcl9/` — Tcl version-specific build output targets +## Repo-wide Notes - - -# AGENTS.md - -Agent handbook for the ShellSpy (Punk Shell) repository. These guidelines cover builds, linting, testing, code style, and day-to-day conventions for all contributors and agentic assistants. Always check for nested `AGENTS.md` files before editing subdirectories. This root spec applies repo-wide unless overridden deeper in the tree. - -if conflict with CLAUDE.md, AGENTS.md wins. - -## Quickstart Checklist -- Confirm Windows-friendly Tcl toolchain (8.6+ required, 9.0 supported). -- Run `tclsh src/make.tcl packages` once after cloning to populate generated assets. -- Keep edits within the scoped instructions of any nested `AGENTS.md`. -- Review VS Code Tcl lint diagnostics before submitting new agent-produced Tcl code, but do not use lint tooling to reformat existing code. -- Execute at least one relevant test script (`tclsh src/tests//.tcl`). -- Document changes impacting build, tooling, or developer workflow. - -## Build & Bootstrap Commands -- **Primary build**: `tclsh make.tcl project` (Windows default) or `punk902z make.tcl project` inside Punk shell. -- **Clean/resync**: Remove `_build/` artifacts then rerun `tclsh make.tcl project`; avoid partial cleans that break boot modules. Cleaning _build is generally not required. -- **Binary images**: Use `punk make.tcl project` to produce punk binaries. There are no platform-specific flags for cross-platform building - it must currently be done on each specific platform. The Tcl modules and libs are mostly cross-platform by nature, but the built binaries rely on platform specific runtimes and some binary packages from whichever src/vfs/*.vfs folder was used to build. - -## Testing Strategy -- **Test location**: `src/tests/` holds all Tcl test scripts; keep new tests there, named with the .test file extension. -- **Run entire suite**: Run base src/tests/runtests.tcl or Iterate with something like `for /r src\tests %f in (*.tcl) do tclsh %f` (Windows) or a similar shell loop on POSIX. -- **Run single test**: `tclsh src/tests//