Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 93 lines (62 sloc) 2.61 kB
e3a9b22 @achiu update README
authored
1 Consular
46dcb5d @nesquena Added initial readme
nesquena authored
2 ===========
3
6e678bb @achiu clean up README and link to wiki
authored
4 Consular automates your development workflow setup.
d5f9b4d @achiu update README contributor list and about the new directory path
authored
5
6e678bb @achiu clean up README and link to wiki
authored
6 Read the rest of the README and check out the [wiki](https://github.com/achiu/consular/wiki) for more info!
e3a9b22 @achiu update README
authored
7
8 Setup && Installation
46dcb5d @nesquena Added initial readme
nesquena authored
9 ------------
10
e3a9b22 @achiu update README
authored
11 Install the consular gem and `init`:
12
13 ```bash
c9b6411 @achiu update README to not use --pre
authored
14 $ gem install consular
e3a9b22 @achiu update README
authored
15 $ consular init
16 ```
17
18 This will generate a global path directory for your scripts to live in
19 at `~/.config/consular` and also a `.consularc` in your home directory.
20 You can customize your Consular further with `.consularc`. Say for
21 example, that you didn't like the default global path:
22
23 ```ruby
24 # ~/.consularc
25
26 Consular.configure do |c|
27 c.global_path = '/a/path/i/like/better'
28 end
29 ```
6e678bb @achiu clean up README and link to wiki
authored
30
31 ## IMPORTANT ##
32
df1fedd @achiu move core up to setup portion of README
authored
33 After that, you'll need to install a 'core' so you can run Consular n
34 your desired platform.
35
36 Cores
37 -----
38
39 Cores allow Consular to operate on a variety of platforms. They abstract the general behavior that consular needs to run the commands.
40 Each core inherits from ([Consular::Core](http://github.com/achiu/consular/blob/master/lib/consular/core.rb)) and defines the needed methods.
41 Some of the cores that are available are:
42
43 * [OSX](http://www.github.com/achiu/consular-osx) - Mac OS X Terminal
44 * [iTerm](https://github.com/achiu/consular-iterm) - Mac OS X iTerm
45 * [Terminator](https://github.com/ilkka/consular-terminator) - Terminator
46 * [Gnome](https://github.com/jc00ke/consular-gnome-terminal) - Gnome Terminal
bb1233c @achiu Update README.md
authored
47 * [Gnome](https://github.com/gorkunov/consular-another-gnome-terminal) - Gnome Terminal Core that doesn't use xdotool
df1fedd @achiu move core up to setup portion of README
authored
48
49 Feel free to contribute more cores so that Consular can support your terminal of choice :)
50
51 To integrate core support for your Consular, you can simply require it
52 in your `.consularc` like so:
53
54 ```ruby
55 # .consularc
56 require 'consular/osx'
57 ```
58
59 Or check the README of each individual core.
e3a9b22 @achiu update README
authored
60
46dcb5d @nesquena Added initial readme
nesquena authored
61
8a6ad80 @achiu update README with development setup info
authored
62 Development Setup
63 ---------------------
64
e3a9b22 @achiu update README
authored
65 To begin development on Consular, run bundler:
8a6ad80 @achiu update README with development setup info
authored
66
67 $ gem install bundler
68 $ bundle install
69
e3a9b22 @achiu update README
authored
70 The test suite uses Minitest
8a6ad80 @achiu update README with development setup info
authored
71 to run the test run:
72
73 $ rake test
74
75 or use watchr:
76
e3a9b22 @achiu update README
authored
77 $ watchr spec.watchr
8a6ad80 @achiu update README with development setup info
authored
78
6e678bb @achiu clean up README and link to wiki
authored
79 #### Note on Patches/Pull Requests
d9a334a @achiu update README
authored
80
6e678bb @achiu clean up README and link to wiki
authored
81 * Fork the project.
82 * Make your feature addition or bug fix.
83 * Add tests for it. This is important so I don't break it in a
84 future version unintentionally.
85 * Commit, do not mess with rakefile, version, or history.
86 (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)
87 * Send me a pull request. Bonus points for topic branches.
46dcb5d @nesquena Added initial readme
nesquena authored
88
6e678bb @achiu clean up README and link to wiki
authored
89 #### Copyright
b8c9ecf @nesquena Added the note about Jeff Emminger being the original developer of th…
nesquena authored
90
6e678bb @achiu clean up README and link to wiki
authored
91 Copyright (c) (2011 - when the Singularity occurs) Arthur Chiu. See LICENSE for details.
73b113d @nesquena Update README to include open command and cleanup
nesquena authored
92
Something went wrong with that request. Please try again.