Skip to content

docs: add fasmg syntax project overview#3

Open
sit-d wants to merge 1 commit into
bitRAKE:mainfrom
sit-d:curation/add-root-readme-2026-07-04
Open

docs: add fasmg syntax project overview#3
sit-d wants to merge 1 commit into
bitRAKE:mainfrom
sit-d:curation/add-root-readme-2026-07-04

Conversation

@sit-d

@sit-d sit-d commented Jul 4, 2026

Copy link
Copy Markdown

Summary

  • add a root README.md so the repository landing page explains the fasmg syntax-generation project
  • map the main script, generated output, fixture, and Tree-sitter paths to their purposes
  • document quick local checks and the optional assembler-backed validation command without overlapping the existing validation-workflow PR

Verification

  • python3 -m py_compile scripts/*.py
  • python3 scripts/lint_grammar.py dist/fasmg.tmLanguage.jsonlint: all 46 regex patterns OK in fasmg.tmLanguage.json
  • ad-hoc verifier /tmp/hermes-verify-fasmg-readme-f8b4drpl.py checked README path references, documented commands, ran the explicit grammar linter, and ran git diff --check; it exited 0 and was removed

Notes / Limitations

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant