项目清理:删除临时文件和示例目录,增强项目规范
- 删除 .vscode/ 编辑器配置 - 删除 other/ 示例和工具目录 - 增强 .gitignore,防止IDE配置和临时文件被提交 - 添加 CONTRIBUTING.md 贡献指南 - 添加 clean_project.sh 项目清理脚本 - 清理所有 .DS_Store 系统文件
This commit is contained in:
+13
-2
@@ -49,10 +49,21 @@ cleanup_project.sh
|
||||
# System files
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
*.swp
|
||||
*~
|
||||
|
||||
# Editor directories and files
|
||||
.vscode/
|
||||
.vs/
|
||||
*.suo
|
||||
*.ntvs*
|
||||
*.njsproj
|
||||
*.sln
|
||||
*.sw?
|
||||
|
||||
# Duplicate release directories
|
||||
XMBOX-Release/
|
||||
|
||||
# Tools and utilities (not part of the project)
|
||||
other/tools/bfg.jar
|
||||
other/tools/cleaner.bat
|
||||
other/
|
||||
tools/
|
||||
@@ -0,0 +1,77 @@
|
||||
# 贡献指南
|
||||
|
||||
## 项目结构
|
||||
|
||||
这是一个Android应用项目,主要使用Java开发。
|
||||
|
||||
### 语言组成
|
||||
- **Java (78.4%)** - 主要应用代码
|
||||
- **JavaScript (9.9%)** - WebView内嵌脚本和爬虫引擎
|
||||
- **CSS (7.3%)** - WebView样式文件
|
||||
- **GLSL (2.5%)** - Media3视频渲染着色器
|
||||
- **Shell (1.1%)** - 构建和部署脚本
|
||||
- **HTML (0.8%)** - WebView页面
|
||||
|
||||
### 目录说明
|
||||
|
||||
```
|
||||
XMBOX/
|
||||
├── app/ # 主应用模块
|
||||
│ ├── src/main/ # 通用代码
|
||||
│ ├── src/leanback/ # 电视版UI代码
|
||||
│ └── src/mobile/ # 手机版UI代码
|
||||
├── catvod/ # 爬虫核心库
|
||||
├── quickjs/ # JavaScript引擎
|
||||
├── thunder/ # 迅雷下载模块
|
||||
├── forcetech/ # P2P模块
|
||||
├── jianpian/ # 减片模块
|
||||
├── tvbus/ # TVBus模块
|
||||
├── zlive/ # 直播模块
|
||||
└── docs/ # 文档
|
||||
|
||||
```
|
||||
|
||||
## 代码规范
|
||||
|
||||
### Java代码
|
||||
- 遵循Android开发规范
|
||||
- 使用驼峰命名法
|
||||
- 类名首字母大写
|
||||
- 方法和变量名首字母小写
|
||||
- 常量全大写,用下划线分隔
|
||||
|
||||
### 资源文件
|
||||
- JavaScript/CSS/HTML位于 `app/src/main/assets/`
|
||||
- 这些文件用于WebView解析和内容抓取,不可删除
|
||||
|
||||
### GLSL着色器
|
||||
- 由Media3库提供,用于视频渲染
|
||||
- 自动生成,不需要手动修改
|
||||
|
||||
## 清理项目
|
||||
|
||||
运行清理脚本:
|
||||
```bash
|
||||
./clean_project.sh
|
||||
```
|
||||
|
||||
这将清理:
|
||||
- 构建产物(build目录)
|
||||
- 临时文件
|
||||
- 系统文件(.DS_Store等)
|
||||
- IDE配置文件
|
||||
|
||||
## 提交代码
|
||||
|
||||
1. 清理项目:`./clean_project.sh`
|
||||
2. 查看改动:`git status`
|
||||
3. 添加文件:`git add .`
|
||||
4. 提交代码:`git commit -m "描述"`
|
||||
5. 推送代码:`git push`
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **不要删除assets目录**中的JS/CSS/HTML文件,这些是应用必需的
|
||||
2. **不要删除GLSL文件**,这些是视频播放器需要的
|
||||
3. 提交前运行 `./gradlew clean` 清理构建产物
|
||||
4. 确保新增的临时文件已添加到 `.gitignore`
|
||||
Executable
+40
@@ -0,0 +1,40 @@
|
||||
#!/bin/bash
|
||||
# XMBOX 项目清理脚本
|
||||
# 清理构建产物和临时文件
|
||||
|
||||
echo "开始清理项目..."
|
||||
|
||||
# 清理构建目录
|
||||
echo "清理构建目录..."
|
||||
./gradlew clean
|
||||
|
||||
# 删除系统文件
|
||||
echo "删除系统文件..."
|
||||
find . -name ".DS_Store" -type f -delete
|
||||
find . -name "Thumbs.db" -type f -delete
|
||||
find . -name "*.swp" -type f -delete
|
||||
find . -name "*~" -type f -delete
|
||||
|
||||
# 删除临时文件
|
||||
echo "删除临时文件..."
|
||||
find . -name "*.tmp" -type f -delete
|
||||
find . -name "*.temp" -type f -delete
|
||||
|
||||
# 删除构建缓存
|
||||
echo "删除构建缓存..."
|
||||
rm -rf .gradle
|
||||
rm -rf build
|
||||
rm -rf app/build
|
||||
rm -rf quickjs/build
|
||||
rm -rf catvod/build
|
||||
rm -rf */build
|
||||
|
||||
# 删除IDE配置文件
|
||||
echo "删除IDE配置文件..."
|
||||
rm -rf .vscode
|
||||
rm -rf .vs
|
||||
rm -rf .idea/workspace.xml
|
||||
rm -rf .idea/tasks.xml
|
||||
|
||||
echo "✅ 清理完成!"
|
||||
echo "项目已清理,可以提交到Git"
|
||||
Reference in New Issue
Block a user