Build instructions
This commit is contained in:
18
codex/README.md
Normal file
18
codex/README.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Codex Build Notes
|
||||
|
||||
This folder contains internal build instructions, implementation architecture notes, and the
|
||||
rolling agent log for `dpg-gauges`.
|
||||
|
||||
These files are not the final user-facing package documentation:
|
||||
|
||||
- `AGENTS.md`: rolling implementation log and current build status
|
||||
- `ARCHITECTURE.md`: internal architecture, module responsibilities, and invariants
|
||||
- `FEATURES.md`: public feature and API contract
|
||||
- `STEPS.md`: ordered implementation plan
|
||||
|
||||
User-facing documentation should live in:
|
||||
|
||||
- `../README.md`
|
||||
- `../docs/GETTING_STARTED.md`
|
||||
- `../docs/EXAMPLES.md`
|
||||
- `../docs/API_REFERENCE.md`
|
||||
Reference in New Issue
Block a user