VMath 使用教程

1. 项目目录结构及介绍

VMath 是一个用于图形计算的向量数学库，其目录结构如下：

vmath/
├── .gitignore           # 忽略文件列表
├── LICENSE              # 开源协议文件
├── README.md            # 项目说明文件
├── src/                 # 源代码目录
│   ├── github/workflows/ # GitHub Actions 工作流目录
│   ├── docs/            # 文档目录
│   ├── tests/           # 测试目录
│   ├── tools/           # 工具目录
│   └── vmath.nimble      # Nimble 包配置文件
└── vmath/
    ├── ...

• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目使用的 MIT 开源协议。
• README.md: 项目的详细说明文档。
• src/: 源代码目录，包含所有实现代码和相关文件。
  • github/workflows/: GitHub Actions 工作流文件，用于自动化构建和测试等。
  • docs/: 项目文档。
  • tests/: 测试代码目录。
  • tools/: 辅助工具目录。
  • vmath.nimble: Nimble 包的配置文件，用于管理 Nim 项目的依赖。

2. 项目的启动文件介绍

VMath 库的启动和构建主要通过 Nim 的包管理器 Nimble 来进行。在项目的根目录下，有一个名为 vmath.nimble 的文件，这是 Nimble 的配置文件。通过以下命令可以安装 VMath 库及其依赖：

nimble install vmath

src/vmath.nim 是库的主源文件，其中定义了向量、矩阵和四元数等数学对象的操作。

3. 项目的配置文件介绍

VMath 库的配置主要通过修改 vmath.nimble 文件来进行。以下是一个基本的 vmath.nimble 文件内容：

# vmath.nimble
version = "2.0.0"
author = "treeform"
description = "Math vector library for graphical things."
license = "MIT"
dependencies = []

# 可以在这里添加依赖项
# dependencies = ["some_other_lib"]

在这个配置文件中，你可以指定库的版本号、作者、描述和开源协议。如果库有依赖项，也可以在这里添加。

此外，VMath 支持不同的后端，如 C、C++ 和 JavaScript。你可以通过编译时的定义来选择不同的实现方式，例如：

# 选择对象基础实现
-d:vmathObjBased

# 选择数组基础实现
-d:vmathArrayBased

# 选择对象数组基础实现（默认）
-d:vmathObjArrayBased

这些编译定义可以在 Nim 的命令行中指定，或者在 Nimble 配置文件中设置。