Skip to content

Add project documentation and language specification#4

Open
Copilot wants to merge 2 commits intomainfrom
copilot/create-repo-documentation
Open

Add project documentation and language specification#4
Copilot wants to merge 2 commits intomainfrom
copilot/create-repo-documentation

Conversation

Copy link

Copilot AI commented Feb 26, 2026

The repository had no usable README — only an unfinished, partially-commented-out language spec draft with a "PARSER NOT UP TO DATE" banner.

README.md

Replaced with a proper project-level README covering:

  • What Zenith is and current implementation status
  • Prerequisites (C++23 compiler, CMake 4.0)
  • Build instructions (cmake -B build && cmake --build build)
  • CLI usage with all supported flags (--target, --braces, --gc) and output artifacts
  • How to run the GoogleTest suite
  • Annotated project structure tree
  • Roadmap checklist

docs/LANGUAGE_SPEC.md (new)

Full language reference extracted from the old README and restructured with a table of contents:

  • Keywords, access modifiers, import directives
  • Type system: primitives, freeobj, built-in class types
  • Control flow and function syntax
  • OOP: classes, inheritance, operator overloading, structs
  • Metaprogramming: annotations and decorators (including how to define custom ones)
  • Enum-based error handling with match
  • Pipelines (WIP)
  • Unique features table, EBNF grammar highlights, JVM interop and unsafe block examples

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: Gogo64pro <96884572+Gogo64pro@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for the repository Add project documentation and language specification Feb 26, 2026
@Gogo64pro Gogo64pro marked this pull request as ready for review February 26, 2026 19:18
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.

2 participants