PureRef-format 开源项目使用教程

1. 项目的目录结构及介绍

PureRef-format 项目是一个Python脚本，用于自动生成PureRef (.pur) 文件。以下是项目的目录结构及其介绍：

PureRef-format/
├── Artists/              # 存放艺术家图片的文件夹
├── Purs/                 # 生成的 PureRef 文件存储的文件夹
├── pureref_gen.py        # 用于生成 PureRef 文件的模块
├── pureref_gen_script.py # 主脚本，用于驱动生成流程
├── purformat.py          # PureRef 文件读写模块
├── requirements.txt      # 项目依赖文件
├── .gitignore            # Git 忽略文件
├── LICENSE              # 项目许可证文件
└── README.md            # 项目说明文件

• Artists/：存放艺术家图片的文件夹，每个子文件夹对应一个艺术家的图片。
• Purs/：生成的 PureRef 文件存储的文件夹。
• pureref_gen.py：包含生成 PureRef 文件的函数。
• pureref_gen_script.py：主脚本，用于执行图片到 PureRef 文件的转换。
• purformat.py：用于读取和写入 PureRef 文件的模块。
• requirements.txt：列出项目运行所需的Python库。
• .gitignore：指定Git应该忽略的文件和文件夹。
• LICENSE：项目使用的许可证信息。
• README.md：项目的说明文件。

2. 项目的启动文件介绍

项目的启动文件是 pureref_gen_script.py。该脚本负责读取 Artists/ 文件夹中的图片，并将它们转换成 PureRef 文件存储在 Purs/ 文件夹中。

使用方法如下：

python pureref_gen_script.py [input_folder] [output_folder]

如果不指定参数，默认会使用 Artists/ 作为输入文件夹，Purs/ 作为输出文件夹。

3. 项目的配置文件介绍

在这个项目中，配置主要是通过代码中的参数和 requirements.txt 文件来进行的。

• requirements.txt：该文件列出了项目运行所需的Python库，例如：

numpy==1.21.2
Pillow==8.3.1

确保在使用项目前安装了所有列出的库。

• 代码中的参数：在 pureref_gen_script.py 脚本中，可以设置输入和输出文件夹的路径。如果没有指定参数，脚本将使用默认的路径。

以上是 PureRef-format 开源项目的使用教程，希望对您有所帮助。