Polatory 开源项目使用教程
1. 项目的目录结构及介绍
Polatory 项目的目录结构如下:
polatory/
├── benchmark/
├── cli/
├── cmake/
├── examples/
├── include/
│ └── polatory/
├── ports/
│ └── intel-mkl/
├── python/
├── src/
├── test/
├── tools/
├── vcpkg/
│ └── bb002e6/
├── clang-format
├── clang-tidy
├── gitignore
├── gitmodules
├── run.ps1
├── CMakeLists.txt
├── LICENSE
├── README.md
├── pyproject.toml
├── run
├── run.bat
├── setup.cfg
├── setup.py
├── vcpkg-configuration.json
└── vcpkg.json
目录介绍
- benchmark/: 包含性能测试相关的文件。
- cli/: 包含命令行接口相关的文件。
- cmake/: 包含 CMake 构建系统的配置文件。
- examples/: 包含示例代码。
- include/polatory/: 包含项目的头文件。
- ports/intel-mkl/: 包含 Intel MKL 库的端口配置。
- python/: 包含 Python 接口和脚本。
- src/: 包含项目的源代码。
- test/: 包含测试代码。
- tools/: 包含辅助工具和脚本。
- vcpkg/: 包含 vcpkg 包管理器的配置文件。
- clang-format: 代码格式化配置文件。
- clang-tidy: 代码静态分析配置文件。
- gitignore: Git 忽略文件配置。
- gitmodules: Git 子模块配置。
- run.ps1: PowerShell 脚本文件。
- CMakeLists.txt: CMake 主配置文件。
- LICENSE: 项目许可证文件。
- README.md: 项目说明文档。
- pyproject.toml: Python 项目配置文件。
- run: 可执行脚本文件。
- run.bat: Windows 批处理脚本文件。
- setup.cfg: Python 安装配置文件。
- setup.py: Python 安装脚本。
- vcpkg-configuration.json: vcpkg 配置文件。
- vcpkg.json: vcpkg 包描述文件。
2. 项目的启动文件介绍
项目的启动文件主要是 run
和 run.bat
。
- run: 这是一个可执行脚本文件,用于启动项目。具体使用方法可以参考项目文档。
- run.bat: 这是一个 Windows 批处理脚本文件,用于在 Windows 环境下启动项目。
3. 项目的配置文件介绍
项目的配置文件主要包括以下几个:
- CMakeLists.txt: 这是 CMake 的主配置文件,定义了项目的构建规则和依赖关系。
- pyproject.toml: 这是 Python 项目的配置文件,定义了项目的元数据和构建系统。
- setup.cfg: 这是 Python 安装配置文件,定义了安装过程中的各种选项。
- setup.py: 这是 Python 安装脚本,用于安装 Python 包。
- vcpkg-configuration.json: 这是 vcpkg 配置文件,定义了 vcpkg 包管理器的配置。
- vcpkg.json: 这是 vcpkg 包描述文件,定义了项目依赖的 vcpkg 包。
以上是 Polatory 开源项目的基本使用教程,希望对您有所帮助。