图像遮挡增强(Anki Add-on)项目教程

1. 项目目录结构及介绍

图像遮挡增强项目是一个为Anki应用开发插件的项目，其目录结构如下：

image-occlusion-enhanced/
├── .github/                    # GitHub相关文件
├── docs/                       # 项目文档
├── screenshots/               # 屏幕截图
├── src/                        # 源代码目录
│   └── image_occlusion_enhanced/ # 插件主体代码
├── tools/                      # 开发工具
│   └── io2-svg-fix/            # SVG修复工具
├── .flake8                     # flake8 Python风格指南配置文件
├── .gitattributes              # Git属性配置文件
├── .gitignore                  # Git忽略文件
├── CHANGELOG.md                # 更新日志
├── CONTRIBUTING.md             # 贡献指南
├── LICENSE                     # 许可证文件
├── Makefile                    # Makefile构建脚本
├── README.md                   # 项目说明文件
├── addon.json                  # Anki插件元数据文件
├── poetry.lock                 # Poetry依赖管理锁定文件
├── pyproject.toml              # Python项目配置文件
├── requirements.txt            # 依赖项列表

• .github/: 包含GitHub工作流程和其他GitHub特定的文件。
• docs/: 存放项目文档。
• screenshots/: 包含插件使用的屏幕截图。
• src/: 源代码目录，包含插件的主要逻辑。
• tools/: 包含项目相关的开发工具。
• .flake8: Python代码风格配置文件。
• .gitattributes: 配置Git属性。
• .gitignore: 指定Git应忽略的文件和目录。
• CHANGELOG.md: 记录了项目的所有更新和改动。
• CONTRIBUTING.md: 提供贡献项目的方法和指南。
• LICENSE: 项目使用的许可证信息。
• Makefile: 构建和打包项目的Makefile文件。
• README.md: 项目说明文件，包含了项目的介绍、安装和使用方法。
• addon.json: 定义了Anki插件的相关元数据。
• poetry.lock 和 pyproject.toml: Python依赖管理文件。
• requirements.txt: 列出了项目所需的Python包。

2. 项目的启动文件介绍

在这个项目中，并没有一个传统意义上的“启动文件”。因为这是一个Anki插件，所以它的“启动”是通过在Anki应用中安装插件来实现的。用户在Anki中安装.ankiaddon文件后，Anki会自动加载这个插件。

插件的核心功能实现在src/image_occlusion_enhanced/目录下的Python文件中。这些文件在Anki启动并加载插件时被调用。

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• addon.json: 这个文件包含了插件的元数据，如插件的名称、版本、描述、作者等。Anki使用这个文件来识别和管理插件。
• pyproject.toml: 这个文件用于配置插件的Python依赖。它告诉Anki或其他包管理工具在安装或更新插件时需要哪些Python包。
• Makefile: 如果需要进行更复杂的构建过程，如编译资源文件等，这个文件会包含相应的命令。

Anki插件的配置通常在Anki的设置界面中完成，而不是通过修改项目文件。插件的具体配置选项会在Anki的插件管理器中提供用户界面供用户设置。