FanFicFare 项目安装与使用指南

1. 项目目录结构及介绍

FanFicFare 项目的主要目录结构如下：

FanFicFare/
├── calibre-plugin/           # Calibre 插件相关文件
├── fanficfare/              # 主程序文件
├── included_dependencies/   # 包含的依赖文件
├── tests/                   # 测试文件
├── .gitignore               # Git 忽略文件列表
├── DESCRIPTION.rst          # 项目描述文件
├── LICENSE                  # 许可证文件
├── MANIFEST.in              # 打包文件列表
├── README.md                # 项目自述文件
├── ini-order.py             # INI 文件顺序处理脚本
├── makeplugin.py            # 插件制作脚本
├── makezip.py               # 压缩包制作脚本
├── pyproject.toml           # 项目配置文件
└── version_update.py        # 版本更新脚本

• calibre-plugin/: 包含了用于 Calibre 电子书管理器的插件相关文件。
• fanficfare/: 主程序代码存放目录。
• included_dependencies/: 存放项目所需的第三方库文件。
• tests/: 包含了项目的单元测试代码。
• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• DESCRIPTION.rst: 包含项目的详细描述信息。
• LICENSE: 项目的许可证信息。
• MANIFEST.in: 指定打包时包含的文件。
• README.md: 项目的自述文件，通常包含了项目的简要介绍和安装使用指南。
• ini-order.py: 脚本用于处理 INI 文件中的顺序。
• makeplugin.py: 脚本用于生成 Calibre 插件。
• makezip.py: 脚本用于制作项目的压缩包。
• pyproject.toml: Python 项目配置文件，用于定义项目信息和依赖。
• version_update.py: 脚本用于更新项目版本。

2. 项目的启动文件介绍

项目的启动主要是通过命令行界面（CLI）进行的。要启动项目，你需要安装 FanFicFare 作为 Python 包。安装完成后，你可以在命令行中使用 FanFicFare 命令来启动程序。

安装命令如下：

pip install FanFicFare

启动 CLI 的基本命令如下：

FanFicFare

执行上述命令后，程序会显示命令行界面，你可以根据提示输入相应的命令来下载和转换电子书。

3. 项目的配置文件介绍

项目的配置主要是通过 pyproject.toml 文件进行。该文件位于项目根目录下，包含了项目的基本信息和依赖关系。

以下是一个 pyproject.toml 文件的示例：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "FanFicFare"
version = "4.44.0"
description = "A tool for making eBooks from stories on fanfiction and other web sites."
authors = ["Your Name <[e-mail]>"]
dependencies = []
readme = "README.md"
license = { file = "LICENSE" }
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
    "Operating System :: OS Independent"
]

在这个配置文件中，你可以定义项目的名称、版本、描述、作者、依赖项、自述文件、许可证以及项目分类等信息。这些信息在打包和分发项目时会被使用。