Consular 技术文档

1. 安装指南

Consular 是一个自动化开发工作流程设置的工具。以下是安装 Consular 的步骤：

首先，安装 consular gem 并执行 init 命令：

$ gem install consular
$ consular init

执行上述命令会在 ~/.config/consular 路径下生成一个全局路径目录，用于存放脚本，并在您的家目录下创建一个 .consularc 文件。

您可以通过 .consularc 文件进一步自定义 Consular。例如，如果您不喜欢默认的全局路径，可以按照以下方式修改：

# ~/.consularc

Consular.configure do |c|
  c.global_path = '/a/path/i/like/better'
end

2. 项目的使用说明

Consular 需要安装一个 'core' 才能在您选择的平台上运行。

Cores

Cores 允许 Consular 在多种平台上运行，它们抽象了 Consular 运行命令所需的一般行为。每个 core 都继承自 Consular::Core 并定义了所需的方法。以下是一些可用的 cores：

• OSX - Mac OS X Terminal
• iTerm - Mac OS X iTerm
• Terminator
• Gnome Terminal
• Another Gnome Terminal Core（不使用 xdotool）

您可以在 .consularc 文件中简单地 require 您想要的 core 来集成 core 支持：

# .consularc
require 'consular/osx'

或者查阅每个单独 core 的 README 文件。

3. 项目API使用文档

Consular 的 API 使用文档目前没有提供。您可以通过查阅项目源代码和相关核心的 README 文件来获取更多信息。

4. 项目安装方式

Consular 的安装方式如上所述，通过 gem 安装并初始化：

$ gem install consular
$ consular init

之后，根据您的平台选择并集成相应的 core。

开发环境的设置需要先安装 bundler：

$ gem install bundler
$ bundle install

测试套件使用 Minitest 进行测试：

$ rake test

或者使用 watchr：

$ watchr spec.watchr

请注意，在提交补丁或拉取请求时，请遵循以下步骤：

• Fork 项目。
• 添加您的功能或修复 bug。
• 为其添加测试。
• 提交，不要修改 rakefile、版本或历史记录。
• 发送拉取请求。

版权所有（2011 - 奇点发生时）Arthur Chiu。详情请参阅 LICENSE 文件。