Consular

Consular automates your development workflow setup.

Read the rest of the README and check out the wiki for more info!

Setup && Installation

Install the consular gem and init:

$ gem install consular
$ consular init

This will generate a global path directory for your scripts to live in at ~/.config/consular and also a .consularc in your home directory. You can customize your Consular further with .consularc. Say for example, that you didn't like the default global path:

# ~/.consularc

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

IMPORTANT

After that, you'll need to install a 'core' so you can run Consular n your desired platform.

Cores

Cores allow Consular to operate on a variety of platforms. They abstract the general behavior that consular needs to run the commands. Each core inherits from (Consular::Core) and defines the needed methods. Some of the cores that are available are:

  • OSX - Mac OS X Terminal
  • iTerm - Mac OS X iTerm
  • Terminator - Terminator
  • Gnome - Gnome Terminal
  • Gnome - Gnome Terminal Core that doesn't use xdotool

Feel free to contribute more cores so that Consular can support your terminal of choice :)

To integrate core support for your Consular, you can simply require it in your .consularc like so:

# .consularc
require 'consular/osx'

Or check the README of each individual core.

Development Setup

To begin development on Consular, run bundler:

$ gem install bundler
$ bundle install

The test suite uses Minitest to run the test run:

$ rake test

or use watchr:

$ watchr spec.watchr

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright (c) (2011 - when the Singularity occurs) Arthur Chiu. See LICENSE for details.



Consular

领事馆自动化您的开发工作流程设置。

阅读README的其余部分,并查看维基了解更多信息!

设置&安装

安装consular gem和 init

$ gem install consular
$ consular init

这将为脚本生成一个全局路径目录 在您的主目录中的〜/ .config / consular 以及 .consularc 。 您可以使用 .consularc 进一步自定义您的领事馆。说, 例如,您不喜欢默认的全局路径:

# ~/.consularc

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

重要事项

之后,您需要安装核心,以便您可以运行Consular n 您所需的平台。

核心

核心允许领事在各种平台上运作。它们抽象了领事馆运行命令所需的一般行为。 每个核心都继承自( Consular :: Core ),并定义了所需的方法。 一些可用的核心是:

随意贡献更多核心,以便领事可以支持您的终端选择:)

为了集成您的领事馆的核心支持,您可以简单地要求它 在你的 .consularc 这样:

# .consularc
require 'consular/osx'

或检查每个核心的README。

开发设置

要开始在领事馆开发,请运行bundler:

$ gem install bundler
$ bundle install

测试套件使用Minitest 运行测试运行:

$ rake test

或使用watchr:

$ watchr spec.watchr

Note on Patches/Pull Requests

  • 使您的功能添加或修复错误。
  • 添加测试。这很重要,所以我不打破它 未来版本无意。
  • 提交,不要混淆rakefile,version或history。 (如果你想拥有自己的版本,那么这个很好,但是提交中的凹凸版本本身就可以忽略)
  • 向我发送拉请求。主题分支的积分。

Copyright

版权所有(c)(2011 - 奇异发生时)Arthur Chiu。有关详细信息,请参阅许可证。




相关问题推荐