Skip to content

Expand README with project overview#56

Draft
rosasurfer wants to merge 1 commit intodevelopmentfrom
codex/analyze-codebase-for-mql4-compatibility
Draft

Expand README with project overview#56
rosasurfer wants to merge 1 commit intodevelopmentfrom
codex/analyze-codebase-for-mql4-compatibility

Conversation

@rosasurfer
Copy link
Copy Markdown
Owner

@rosasurfer rosasurfer commented Mar 13, 2026

Changes and PR have been generated by ChatGPT Codex.

Motivation

  • Provide a comprehensive architecture and onboarding document that explains the repository's MT4-first design and MQL dialect distinctions (MQL4.0, MQL4.5, MQL5).
  • Make intentional design choices explicit (triplicated rsfHistory1/2/3 libraries, rsfMT4Expander.dll boundary, legacy init()/start()/deinit() lifecycle) to reduce accidental regressions when modifying core code.
  • Improve the top-level README.md so contributors can quickly find compile instructions, subsystem descriptions, and configuration/contribution guidance.

Description

  • Add CODEBASE_ANALYSIS.md with an executive summary, detailed analysis of mql40 subsystems, history libraries, logging/error-handling, three-layer configuration model, and contributor guidance.
  • Update README.md to include a clear project overview, supported dialects, bin/mqlc compilation guidance, a high-level list of major framework subsystems, configuration precedence (global -> terminal -> account), and contributor recommendations to preserve legacy lifecycle hooks.
  • Reformat and reorganize existing README content and add a direct pointer to CODEBASE_ANALYSIS.md for deep-dive architecture documentation.

Testing

  • No automated tests were added or modified because this change only affects documentation files.
  • Repository CI configuration was not changed by this PR and no CI runs were triggered as part of this rollout.
  • Please run the existing automated CI (e.g., GitHub Actions) as usual to validate repository checks if desired.

Codex Task

@rosasurfer rosasurfer changed the title Add CODEBASE_ANALYSIS.md and expand README with project overview and contributor guidance Expand README with project overview Mar 13, 2026
@rosasurfer rosasurfer self-assigned this Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant