mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-03-23 03:04:29 +08:00
1ea0eac6a2
- 配置docfx.json以支持多项目源文件生成API文档 - 添加filterConfig.yml过滤测试和内部实现相关代码 - 创建主页index.md介绍GFramework框架特性 - 配置多层级目录结构toc.yml组织文档导航 - 设置构建输出路径和全局元数据配置
33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
# GFramework Documentation
|
|
|
|
Welcome to the GFramework documentation!
|
|
|
|
## Overview
|
|
|
|
GFramework is a comprehensive game development framework built with clean architecture principles. It provides a solid foundation for building scalable and maintainable game applications.
|
|
|
|
## Key Features
|
|
|
|
- **Clean Architecture**: Well-defined separation of concerns
|
|
- **Modular Design**: Pluggable architecture modules
|
|
- **Event System**: Robust event-driven programming
|
|
- **Command Pattern**: Structured command execution
|
|
- **Property Binding**: Reactive property system
|
|
- **Coroutine Support**: Asynchronous programming utilities
|
|
- **IOC Container**: Dependency injection support
|
|
- **Logging System**: Comprehensive logging capabilities
|
|
|
|
## Getting Started
|
|
|
|
Check out the [API Documentation](api/) for detailed reference, or explore the specific modules in the navigation menu.
|
|
|
|
## Modules
|
|
|
|
- **Core**: Fundamental framework components
|
|
- **Game**: Game-specific extensions
|
|
- **Godot**: Godot engine integration
|
|
- **Source Generators**: Compile-time code generation
|
|
|
|
## Contributing
|
|
|
|
Please read our contributing guidelines before submitting pull requests. |