ObjectiveGit 技术文档

本文档旨在帮助用户安装、使用和理解 ObjectiveGit 项目。以下内容涵盖了安装指南、项目使用说明以及项目 API 使用文档。

1. 安装指南

Xcode 环境

ObjectiveGit 需要使用 Xcode 7 或更高版本构建框架和运行单元测试。

安装依赖

运行 script/bootstrap 脚本自动安装构建框架所需的依赖。此脚本使用 Homebrew 安装以下工具：

• cmake
• libtool
• autoconf
• automake
• pkg-config
• libssh2

如果您的 Mac 未安装 Homebrew，则需要手动安装上述工具。

开发环境

要独立开发 ObjectiveGit，请打开 ObjectiveGitFramework.xcworkspace 文件。

2. 项目使用说明

ObjectiveGit 为 OS X 和 iOS 8 或更高版本提供了 libgit2 库的 Cocoa 绑定。

功能概览

• 读取：日志、差异、责任、历史记录、状态
• 写入：初始化、检出、提交、分支、标签、重置
• 内部：配置、树、块、对象数据库
• 网络：克隆、获取、推送、拉取
• 传输：HTTP、HTTPS、SSH、本地文件系统

并非所有 libgit2 功能都已提供，但如果您遇到缺失的功能，请考虑贡献一个 pull request！

ObjectiveGit API 中的许多类封装了 libgit2 中的 C 结构体，并使用 Cocoa 习惯暴露底层数据和操作。底层 libgit2 类型以 git_ 为前缀，通常可以通过属性访问，以便您的应用程序可以直接利用 libgit2 API。

ObjectiveGit API 大量使用了 Cocoa NSError 模式。公共 API 还使用了 nullability 属性，以便在编译时提供 nil 是否允许的反馈。这也使得框架在 Swift 中更加易于使用。

引入框架

在您的项目中使用 #import <ObjectiveGit/ObjectiveGit.h> 或 @import ObjectiveGit; 引入 ObjectiveGit 框架。

3. 项目 API 使用文档

ObjectiveGit API 提供了丰富的接口，以下是一些关键类和方法的简要说明：

• OGRepository: 代表一个 Git 仓库。
• OGCommit: 代表一个 Git 提交。
• OGBranch: 代表一个 Git 分支。
• OGTag: 代表一个 Git 标签。
• OGStatus: 提供仓库状态信息。
• OGDiff: 提供提交、树或文件之间的差异信息。

具体 API 使用请参考 ObjectiveGit 的头文件和文档。

4. 项目安装方式

ObjectiveGit 支持以下三种安装方式：

Carthage

1. 在您的 Cartfile 中添加 ObjectiveGit：

   github "libgit2/objective-git"
   

2. 运行 carthage update。

3. 对于 Mac 目标，将 ObjectiveGit.framework 从 Carthage/Build/Mac 文件夹拖放到应用目标的 "Embedded Binaries" 部分。

4. 对于 iOS 目标，将 ObjectiveGit.framework 从 Carthage/Build/iOS 文件夹拖放到应用目标的 "Linked Frameworks and Libraries" 部分，并添加相应的运行脚本。

手动安装

1. 从 releases 下载最新的 ObjectiveGit.framework.zip。
2. 解压文件，并按照 Carthage 指导的步骤 3 或 4 操作。

子项目

1. 将 ObjectiveGit 作为子模块添加到您的项目：

   git submodule add https://github.com/libgit2/objective-git.git External/ObjectiveGit
   

2. 运行 script/bootstrap。

3. 将 ObjectiveGitFramework.xcodeproj 文件拖入项目导航器。

4. 添加 ObjectiveGit-Mac 或 ObjectiveGit-iOS 作为您的应用目标的依赖项。

5. 链接您的应用目标与 ObjectiveGit.framework。

6. 设置 "Header Search Paths" (HEADER_SEARCH_PATHS) 构建设置，指向 libgit2 头文件的正确路径。

7. 添加一个新的 "Copy Files" 构建阶段，将目标设置为 "Frameworks"，并添加 ObjectiveGit.framework。

以上就是 ObjectiveGit 的技术文档，希望对您的使用有所帮助。