poly-decomp.js 教程

1. 项目目录结构及介绍

以下是 poly-decomp.js 的基本目录结构及其功能说明：

.
├── build/               包含编译后的库文件（如 `decomp.js`, `decomp.min.js`）
├── docs/                文档相关文件
├── src/                 存放源代码
│   ├── decomp.js        主要的解构算法实现
│   └── ...              其他辅助文件
├── test/                测试用例和相关脚本
├── .gitignore           Git 忽略文件列表
├── .jshintrc            JavaScript 风格检查配置
├── Gruntfile.js         使用 Grunt 构建工具的配置文件
├── LICENSE              许可证信息
└── README.md            项目读我文件，包含简介和使用指南

2. 项目的启动文件介绍

该项目的主要入口点是源代码中的 src/decomp.js 文件，这个文件包含了用于分解2D多边形为凸片的函数。在浏览器环境下，你可以直接引入编译好的 build/decomp.js 或压缩版的 build/decomp.min.js 到HTML中。

例如，在HTML文件中引入库：

<script src="path/to/decomp.min.js" type="text/javascript"></script>

然后就可以访问全局变量 decomp 来调用相关的解构方法。

在Node.js环境中，你可以通过npm安装并导入库：

npm install poly-decomp

之后在JavaScript文件中：

var decomp = require('poly-decomp');

3. 项目的配置文件介绍

Gruntfile.js

Gruntfile.js 是一个构建脚本，它定义了如何通过Grunt自动化工具来编译和测试项目。主要的任务包括：

• default: 默认任务，通常执行lint和build。
• lint: 检查JavaScript代码风格，遵循.jshintrc配置。
• build: 编译源代码到build/目录下，生成decomp.js和其minified版本decomp.min.js。

为了运行这些任务，你需要先全局安装Grunt和项目依赖：

npm install -g grunt-cli
npm install

然后可以执行：

grunt

这将默认执行所有任务，包括代码风格检查和构建过程。

请注意，由于这是一个简单的库，没有复杂的配置或动态设置，因此"配置文件"主要是指Gruntfile.js中的任务配置。