From 5545b76e0b2ecc5cf13c4105b039d2f34c6d8cd8 Mon Sep 17 00:00:00 2001
From: Wang Defa <wangdefa@noreply.gitea.bcde.io>
Date: Wed, 3 Dec 2025 16:41:21 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 183 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1b58cdf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,183 @@
+# XXXigCC
+
+> 禁用捐赠功能的 XMRigCC 修改版本。
+
+[![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](LICENSE)
+[![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)](.gitea/workflows/ci.yaml)
+
+## 🎯 主要特性
+
+- 🚫 **零捐赠** - 捐赠等级设为 0，所有捐赠端点已禁用
+- 🏗️ **多架构支持** - 原生支持 AMD64 和 ARM64 架构
+- 📦 **多种安装方式** - 提供 Debian 包和通用二进制包
+- 🐧 **多发行版兼容** - 支持 Ubuntu、Debian 和 Alpine Linux
+- 🎛️ **集中化管理** - 通过 Web UI 集中管理多个挖矿节点
+- 🔄 **自动更新** - 通过 Debian 仓库轻松安装和更新
+
+## 🚀 快速开始
+
+### 方式一：Debian/Ubuntu（推荐）
+
+#### Debian 12 (Bookworm)
+
+```bash
+# 1. 下载并添加 GPG 密钥
+sudo curl https://gitea.bcde.io/api/packages/wangdefa/debian/repository.key \
+  -o /etc/apt/keyrings/gitea-wangdefa.asc
+
+# 2. 添加软件源
+echo "deb [signed-by=/etc/apt/keyrings/gitea-wangdefa.asc] https://gitea.bcde.io/api/packages/wangdefa/debian bookworm main" | \
+  sudo tee -a /etc/apt/sources.list.d/wangdefa.list
+
+# 3. 安装
+sudo apt-get update
+sudo apt-get install xxxigcc
+```
+
+#### Debian 13 (Trixie)
+
+```bash
+# 使用 trixie 替换上述命令中的 bookworm
+echo "deb [signed-by=/etc/apt/keyrings/gitea-wangdefa.asc] https://gitea.bcde.io/api/packages/wangdefa/debian trixie main" | \
+  sudo tee -a /etc/apt/sources.list.d/wangdefa.list
+```
+
+### 方式二：通用二进制包
+
+```bash
+# 1. 下载对应架构的包
+wget https://gitea.bcde.io/releases/download/VERSION/xxxigcc-amd64-ubuntu-VERSION.tar.gz
+
+# 2. 解压
+tar -xzf xxxigcc-amd64-ubuntu-VERSION.tar.gz
+cd xxxigcc
+
+# 3. 编辑配置文件
+nano config.json          # 用于 Daemon/Miner
+nano config_cc.json       # 用于 Server
+
+# 4. 运行
+./xxxigDaemon --config config.json                    # 挖矿客户端
+# 或
+./xxxigServer --config config_cc.json                 # 控制服务器
+```
+
+## 📋 使用说明
+
+### Debian/Ubuntu 系统服务
+
+#### 启动服务器（控制中心）
+
+```bash
+# 配置文件位置：/etc/xxxigcc/config_cc.json
+sudo systemctl enable xxxigcc-server.service
+sudo systemctl start xxxigcc-server.service
+
+# 查看状态
+sudo systemctl status xxxigcc-server.service
+
+# 查看日志
+sudo journalctl -u xxxigcc-server -f
+```
+
+#### 启动挖矿客户端
+
+```bash
+# 配置文件位置：/etc/xxxigcc/config.json
+sudo systemctl enable xxxigcc-daemon.service
+sudo systemctl start xxxigcc-daemon.service
+
+# 查看状态
+sudo systemctl status xxxigcc-daemon.service
+
+# 查看日志
+sudo journalctl -u xxxigcc-daemon -f
+```
+
+### 访问 Web 管理界面
+
+服务器启动后，访问：
+```
+http://服务器IP:3344
+```
+
+默认凭据（请及时修改）：
+- 用户名：admin
+- 密码：请查看配置文件
+
+## ⚙️ 配置说明
+
+### 配置文件位置
+
+#### Debian/Ubuntu 系统包
+
+```
+/etc/xxxigcc/config.json        # Daemon/Miner 配置
+/etc/xxxigcc/config_cc.json     # Server 配置
+/var/log/xxxigcc/              # 日志目录
+```
+
+#### 通用二进制包
+
+```
+./config.json                   # Daemon/Miner 配置
+./config_cc.json                # Server 配置
+```
+
+### 主要配置项
+
+#### config.json (Daemon/Miner)
+
+```json
+{
+  "cc-url": "控制服务器地址",
+  "cc-access-token": "访问令牌",
+  "cc-worker-id": "工作节点ID",
+  "pools": [
+    {
+      "url": "矿池地址",
+      "user": "钱包地址",
+      "pass": "密码"
+    }
+  ]
+}
+```
+
+#### config_cc.json (Server)
+
+```json
+{
+  "cc-port": 3344,
+  "cc-user": "admin",
+  "cc-pass": "管理员密码",
+  "cc-access-token": "访问令牌",
+  "cc-enable-tls": false
+}
+```
+
+## 🔄 修改内容
+
+本项目基于 [Bendr0id/xmrigCC](https://github.com/Bendr0id/xmrigCC) 进行以下修改：
+
+1. **禁用捐赠**：`kDefaultDonateLevel` 设为 0
+2. **捐赠端点**：重定向到本地 (127.0.0.1)
+3. **详细日志**：默认启用详细日志模式
+4. **项目重命名**："xmrigcc" → "xxxigcc"
+
+所有修改通过 [init.sh](init.sh) 在构建过程中自动应用。
+
+## 📝 许可证
+
+本项目基于 GPL-3.0 许可证开源。
+
+- 原始项目：[XMRigCC](https://github.com/Bendr0id/XMRigCC) (GPL-3.0)
+- 修改内容：详见 [init.sh](init.sh)
+
+## 🙏 致谢
+
+- [XMRigCC](https://github.com/Bendr0id/XMRigCC) - 原始项目
+- [XMRig](https://github.com/xmrig/xmrig) - 核心挖矿引擎
+
+## ⚠️ 免责声明
+
+本软件仅供学习和研究使用。使用本软件进行挖矿活动请遵守当地法律法规。作者不对使用本软件造成的任何损失或法律问题负责。