BadDNS 项目使用教程

1. 项目目录结构及介绍

BadDNS 项目目录结构如下：

baddns/
├── .github/
│   └── workflow/
│       └── ...
├── baddns/
│   ├── __init__.py
│   ├── ...
│   └── ...
├── docs/
│   ├── ...
│   └── ...
├── tests/
│   ├── ...
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── codecov.yml
├── mkdocs.yml
├── poetry.lock
├── pyproject.toml
└── ...

• .github/：包含 GitHub 工作流文件，用于自动化测试、构建等。
• baddns/：项目主目录，包含所有的 Python 源代码和模块。
• docs/：存放项目文档的目录。
• tests/：存放单元测试的代码。
• .gitignore：配置 Git 忽略的文件。
• LICENSE：项目的许可文件，本项目采用 AGPL-3.0 许可。
• README.md：项目说明文件，包含项目简介和使用说明。
• codecov.yml：配置 codecov 的代码覆盖率。
• mkdocs.yml：配置 mkdocs 文档生成工具。
• poetry.lock 和 pyproject.toml：Python 项目依赖管理文件。

2. 项目的启动文件介绍

项目的启动文件是位于 baddns/ 目录下的 __init__.py 文件。这个文件通常用于初始化项目的各个模块，并在运行时加载这些模块。用户可以直接通过命令行运行 baddns.py 文件来启动项目，该文件会调用 baddns/ 目录下的主模块。

3. 项目的配置文件介绍

项目的配置文件主要包含 mkdocs.yml，该文件用于配置 mkdocs 文档生成工具。mkdocs 是一个用于生成静态网站的 Python 库，本项目使用它来生成项目的文档。

mkdocs.yml 文件的基本结构如下：

site_name: BadDNS
nav:
- 'index.md'
- 'usage.md'
- 'modules.md'
- 'about.md'

在上述配置中，site_name 定义了网站的标题，而 nav 定义了导航栏中的链接，它们指向不同的 Markdown 文件，这些文件在 docs/ 目录下。用户可以根据需要添加或修改这些配置，以适应不同的文档需求。