Wang Defa
20935a6c89
All checks were successful
Build and Release / build-and-test (arm64, alpine) (push) Successful in -11s
Build and Release / build-and-test (amd64, alpine) (push) Successful in -4s
Build and Release / build-and-test (arm64, ubuntu) (push) Successful in 1s
Build and Release / build-and-test (amd64, ubuntu) (push) Successful in 10s
Build and Release / release (push) Successful in 44s
- 初始化 llmdoc 文档系统（overview/architecture/guides/reference） - 创建 9 个核心文档，涵盖项目概览、安装架构、配置系统等 - 升级 CI 工作流和构建脚本版本号至 3.4.8-xg1 - 添加 .gitignore 文件
97 lines
3.1 KiB
Markdown
97 lines
3.1 KiB
Markdown
# XXXigCC 项目文档
|
||
|
||
欢迎来到 XXXigCC 项目文档！本文档系统为 LLM 优化，帮助您快速理解和使用 XXXigCC。
|
||
|
||
## 📖 文档结构
|
||
|
||
### Overview（概览）
|
||
|
||
高层次的项目理解，回答"这个项目是什么？"
|
||
|
||
- **[项目概览](overview/project-overview.md)**：项目目的、核心组件、技术特性
|
||
|
||
### Architecture（架构）
|
||
|
||
系统的构建方式（LLM 检索地图），回答"它是如何工作的？"
|
||
|
||
- **[安装架构](architecture/installation-architecture.md)**：安装机制的设计和执行流程
|
||
- **[配置系统架构](architecture/configuration-system.md)**：配置管理系统的设计
|
||
- **[项目修改架构](architecture/project-modifications.md)**：从 XMRigCC 到 XXXigCC 的修改内容
|
||
|
||
### Guides（指南）
|
||
|
||
分步操作说明，回答"如何做 X？"
|
||
|
||
- **[如何使用 tar.gz 安装](guides/how-to-install-via-tarball.md)**：tar.gz 包安装指南
|
||
- **[如何配置挖矿节点](guides/how-to-configure-miner.md)**：挖矿节点的配置说明
|
||
|
||
### Reference（参考）
|
||
|
||
详细的参考信息，回答"X 的具体细节是什么？"
|
||
|
||
- **[编码规范](reference/coding-conventions.md)**：项目的编码约定
|
||
- **[Git 规范](reference/git-conventions.md)**：Git 提交和分支约定
|
||
|
||
## 🚀 快速开始
|
||
|
||
### 我想了解项目
|
||
1. 阅读 [项目概览](overview/project-overview.md)
|
||
2. 了解 [项目修改架构](architecture/project-modifications.md)
|
||
|
||
### 我想安装 XXXigCC
|
||
1. 查看 [如何使用 tar.gz 安装](guides/how-to-install-via-tarball.md)
|
||
2. 参考 [安装架构](architecture/installation-architecture.md) 了解底层机制
|
||
|
||
### 我想配置挖矿
|
||
1. 阅读 [如何配置挖矿节点](guides/how-to-configure-miner.md)
|
||
2. 参考 [配置系统架构](architecture/configuration-system.md) 深入理解
|
||
|
||
### 我想贡献代码
|
||
1. 了解 [编码规范](reference/coding-conventions.md)
|
||
2. 遵循 [Git 规范](reference/git-conventions.md)
|
||
3. 阅读 [项目修改架构](architecture/project-modifications.md)
|
||
|
||
## 🔍 核心概念
|
||
|
||
### 主要组件
|
||
- **xxxigDaemon**：守护进程，管理挖矿任务
|
||
- **xxxigMiner**：核心挖矿程序
|
||
- **xxxigServer**：Web 控制中心（端口 3344）
|
||
|
||
### 支持的平台
|
||
- **操作系统**：Alpine Linux, Debian/Ubuntu
|
||
- **架构**：x86_64 (amd64), aarch64 (arm64)
|
||
- **安装方式**：tar.gz, Debian 包, Docker
|
||
|
||
### 关键特性
|
||
- ✅ 零捐赠模式（捐赠级别固定为 0）
|
||
- ✅ 集中化管理（CC）
|
||
- ✅ 多平台支持
|
||
- ✅ 灵活的配置系统
|
||
|
||
## 📂 项目资源
|
||
|
||
- **主 README**：[../README.md](../README.md)
|
||
- **安装脚本**：[../script/](../script/)
|
||
- **Debian 构建**：[../debian/](../debian/)
|
||
- **修改脚本**：[../init.sh](../init.sh)
|
||
|
||
## 🤝 原始项目
|
||
|
||
XXXigCC 基于以下开源项目：
|
||
- [XMRigCC](https://github.com/Bendr0id/XMRigCC)：原始项目
|
||
- [XMRig](https://github.com/xmrig/xmrig)：核心挖矿引擎
|
||
|
||
## 📝 文档维护
|
||
|
||
本文档系统遵循以下原则：
|
||
- **Overview**：高层次概念理解
|
||
- **Architecture**：LLM 检索地图，解释系统如何工作
|
||
- **Guides**：实际操作步骤
|
||
- **Reference**：详细参考资料
|
||
|
||
---
|
||
|
||
**生成时间**：2025-12-25
|
||
**文档版本**：1.0
|