ProjectorKit

iOS SDK for Projector

开始使用

有关 Projector 的详细介绍，请阅读我们的 入门指南。

要将 iOS SDK 集成到您的应用程序中，请从 安装 ProjectorKit 开始。

文档

文档可以在 docs.projector.com 找到。 ProjectorKit SDK 参考位于 projectorhq.github.io/ProjectorKit

获取帮助

• 需要帮助？ 有三种方式可以联系我们
  • 我们的公共 Slack
  • 通过电子邮件 [email protected] 联系我们
  • 通过您的 仪表板 联系支持

• 报告一个错误？ 打开问题。如果可能，包括版本、日志文件和显示问题的项目。
• 请求一个功能？ 打开问题。告诉我们您想要的功能以及为什么需要这个功能。请注意，此功能是为 ProjectorKit 请求的。对于通用的 Projector 功能，请通过帮助选项之一联系我们。

开发

ProjectorKit 目前使用 Xcode 7.3（7D175）进行开发。

它还依赖于以下内容进行开发

• SwiftCheck，用于测试目的
  • 通过 Homebrew 和 Carthage 进行管理

• xcpretty
  • 通过 RubyGems 进行管理

• jazzy，用于文档
  • 也通过 RubyGems 进行管理

为开发做准备

首先，安装 Homebrew，按照 Homebrew 项目页面上的文档操作。

接下来，设置 ProjectorKit 开发环境，打开 Terminal.app 并进入 ProjectorKit 目录。在 shell 提示符下输入

> make init

这个命令将安装 RubyGems 的 RubyGems xcpretty 和 jazzy。也将通过 Homebrew 安装 Carthage。

安装 SwiftCheck

为了运行 ProjectorKit 测试套件，您需要通过 Carthage检出和构建 SwiftCheck。同样，在 Terminal.app 中，在 ProjectorKit 目录下，在提示符下输入

> make deps

通过 Jazzy 生成文档

• 首先，按照上述说明安装 RubyGems。
• 在 Terminal.app 中，在 ProjectorKit 目录下，在 shell 提示符下输入以下命令

> make headerdoc

这将创建一个名为 docs 的目录，其中包含生成的 ProjectorKit SDK 参考文档。

贡献

有关详细信息，请参阅 CONTRIBUTING.md。

许可

ProjectorKit 在一个修改过的 BSD 许可证下发布。有关更多信息，请参阅 LICENSE。