Hammer 项目技术文档

1. 安装指南

准备工作

在开始安装之前，请确保您的系统已经安装以下依赖项：

• SCons

以下依赖项是可选的，但建议安装以获得完整功能：

• pkg-config (用于 scons test)
• glib-2.0 (≥ 2.29) (用于 scons test)
• glib-2.0-dev (用于 scons test)
• swig (用于 Python/Perl/PHP 绑定；Perl 需要 ≥ 2.0.8)
• python2.7-dev (用于 Python 绑定)
• JDK (用于 Java 绑定)
• phpenv 配置（用于 PHP 绑定）
• Ruby ≥ 1.9.3 和 bundler（用于 Ruby 绑定）
• mono-devel 和 mono-mcs (≥ 3.0.6)（用于 .NET 绑定）
• nunit (用于测试 .NET 绑定)

安装步骤

1. 克隆项目到本地：

   git clone https://github.com/UpstandingHackers/hammer.git
   cd hammer
   

2. 构建项目：

   scons
   

3. 运行内置测试套件：

   scons test
   

   若要构建调试版本，请添加 --variant=debug 参数。

4. 构建绑定：

   scons bindings=python  # 例如，构建 Python 绑定
   scons bindings=python test  # 构建 Python 绑定并运行测试
   

   可以同时构建多个绑定，只需用逗号分隔即可，例如：

   scons bindings=python,perl
   

5. 若要全局安装 Hammer，请使用以下命令：

   scons install
   

   默认情况下，这会将头文件放在 /usr/local/include/hammer，库文件放在 /usr/local/lib。若要安装到其他位置，请添加 prefix=<destination> 参数。

2. 项目使用说明

使用 Hammer 只需包含头文件：

#include <hammer/hammer.h>

如果您计划使用任何便捷宏，还需要包含：

#include <hammer/glue.h>

链接时使用 -lhammer。

如果 Hammer 已全局安装，您可以使用 pkg-config。

有关详细文档，请查看 用户指南。

3. 项目API使用文档

请参考 用户指南 以获取 API 使用和示例。

4. 项目安装方式

请遵循上述“安装指南”中的步骤进行安装。

---

本文档介绍了 Hammer 项目的安装、使用和 API 文档。请参考用户指南以获取更多详细信息。