Pigeon 技术文档

1. 安装指南

Pigeon 是一个面向快速原型设计和构建智能、可扩展网站的 OOCSS 框架。在开始使用 Pigeon 前，你需要进行以下安装步骤：

对于 Sass 用户：

1. 首先安装 Sass 命令行工具。可以从 Sass 官网 下载适合你操作系统的版本。
2. 如果你在 Windows 系统上，还需要安装 Make for Windows。

对于普通 CSS 用户：

1. 下载 Pigeon 的最新版本，可以从其 GitHub 页面 获取。
2. 将下载的 pigeon.css 或 pigeon.min.css 文件包含在你的页面中，放在你自己的样式表之上。

2. 项目的使用说明

Pigeon 非常易于使用且高度可配置，你可以使用纯 CSS 或 Sass。以下是使用 Pigeon 的基本步骤：

1. 将 Pigeon 的 CSS 文件包含在你的项目中。
2. 根据需要，可以通过 Sass 变量对 Pigeon 进行自定义配置。
3. 使用 Pigeon 提供的 CSS 对象来布局和样式化你的网站。

Pigeon 官方网站提供了完整的文档，你可以参考以下资源：

• 安装和使用 Pigeon
• 配置 Pigeon，以及根据你的需求进行自定义

3. 项目API使用文档

Pigeon 的 API 文档详细介绍了所有 OOCSS 对象的用法。你可以通过以下链接查看：

• Pigeon 的 OOCSS 对象

4. 项目安装方式

如果你打算从源代码构建 Pigeon，你需要执行以下步骤：

1. 确保已经安装了 Sass 命令行工具和 Make 工具（对于 Windows 用户）。

2. 从 GitHub 克隆或下载 Pigeon 的源代码。

3. 使用以下命令编译 Sass 源代码到 CSS：

   $ make compile # 编译 Sass 源代码到 CSS
   $ make minify # 编译 Sass 源代码到 CSS 并压缩
   

   如果你没有指定构建目标，make 将默认执行 minify 和 compile。因此，你也可以简单地使用以下命令：

   $ make
   

4. 在 lib 目录下工作；build 目录中的文件是由构建工具生成的。在提交 pull request 之前，请运行 make 并提交生成的文件。

Pigeon 框架遵循 MIT 许可协议，版权所有者为 Rowan Manning。