Sorty 项目启动与配置教程

1. 项目目录结构及介绍

Sorty 项目目录结构如下所示：

sorty/
├── bin/                    # 存放可执行文件
├── config/                 # 配置文件目录
│   └── config.json         # 项目配置文件
├── doc/                    # 项目文档目录
├── lib/                    # 项目核心库文件
├── scripts/                # 脚本文件目录
├── src/                    # 源代码目录
│   ├── main.py             # 主程序文件
│   ├── utils/              # 工具模块目录
│   └── ...                 # 其他源代码文件
├── test/                   # 测试代码目录
├── .gitignore              # Git 忽略文件
└── README.md               # 项目说明文件

• bin/: 存放项目的可执行文件。
• config/: 存放项目的配置文件。
• doc/: 存放项目相关的文档。
• lib/: 存放项目依赖的核心库文件。
• scripts/: 存放项目运行过程中需要的脚本文件。
• src/: 存放项目的主要源代码。
  • main.py: 项目的主程序文件。
  • utils/: 存放项目所需的各种工具模块。
• test/: 存放项目的测试代码。
• .gitignore: 指定 Git 忽略跟踪的文件。
• README.md: 项目说明文件，介绍项目的基本信息。

2. 项目的启动文件介绍

项目的启动文件为 src/main.py。该文件负责初始化项目，加载配置文件，并启动核心功能。

启动命令如下：

python src/main.py

执行该命令后，主程序会按照以下步骤运行：

1. 加载配置文件 config/config.json。
2. 初始化项目环境。
3. 根据配置文件中的参数启动相应的功能。

3. 项目的配置文件介绍

项目的配置文件为 config/config.json。该文件以 JSON 格式存储，包含了项目运行时所需的各项参数。

配置文件的基本结构如下：

{
  "option1": "value1",
  "option2": "value2",
  "option3": {
    "suboption1": "subvalue1",
    "suboption2": "subvalue2"
  },
  ...
}

配置文件中包含的参数及其含义如下：

• option1: 参数1的值。
• option2: 参数2的值。
• option3: 参数3的嵌套结构，包含子参数。

根据项目的具体需求，配置文件中可能还会包含其他参数。在项目启动时，main.py 会读取这些参数，并根据它们配置项目的行为。