Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 29 lines (21 sloc) 0.884 kB
62289e3 @rohit Add CI build status image to Readme
rohit authored
1 [![Build Status](https://secure.travis-ci.org/wycats/thor.png?branch=master)](http://travis-ci.org/wycats/thor)
2
23b32a2 @sferik Update installation instructions; link to LICENSE
sferik authored
3 Thor
4 ====
a8de418 @wycats Initial checkin of Hermes
wycats authored
5
23b32a2 @sferik Update installation instructions; link to LICENSE
sferik authored
6 Description
7 -----------
8 Thor is a simple and efficient tool for building self-documenting command line
9 utilities. It removes the pain of parsing command line options, writing
10 "USAGE:" banners, and can also be used as an alternative to the [Rake][rake]
11 build tool. The syntax is Rake-like, so it should be familiar to most Rake
12 users.
606d108 @seeflanigan Add description & installation instructions
seeflanigan authored
13
23b32a2 @sferik Update installation instructions; link to LICENSE
sferik authored
14 [rake]: https://github.com/jimweirich/rake
606d108 @seeflanigan Add description & installation instructions
seeflanigan authored
15
23b32a2 @sferik Update installation instructions; link to LICENSE
sferik authored
16 Installation
17 ------------
18 gem install thor
3cf7db3 @seeflanigan Minor documentation tweaks
seeflanigan authored
19
23b32a2 @sferik Update installation instructions; link to LICENSE
sferik authored
20 Usage and documentation
21 -----------------------
1e37b49 @derickbailey removed documentation from readme as it's now in the wiki
derickbailey authored
22 Please see [the wiki](https://github.com/wycats/thor/wiki) for basic usage and other documentation on using Thor.
f91c69b Adding an example generator, a section on further reading about
Jonathan Hicks authored
23
23b32a2 @sferik Update installation instructions; link to LICENSE
sferik authored
24 License
25 -------
26 Released under the MIT License. See the [LICENSE][license] file for further details.
a699ed7 @mislav update (incorrect) README and task.thor sample file
mislav authored
27
23b32a2 @sferik Update installation instructions; link to LICENSE
sferik authored
28 [license]: https://github.com/wycats/thor/blob/master/LICENSE.md
Something went wrong with that request. Please try again.