minor README.txt tweaks
[trollop:mainline.git] / README.txt
1 == trollop
2
3 by William Morgan (http://masanjin.net/)
4
5 Main page: http://trollop.rubyforge.org
6
7 Release announcements and comments: http://all-thing.net/search/label/trollop
8
9 Documentation quickstart: See Trollop::options (for some reason rdoc isn't
10 linking that; it's in the top right of the screen if you're browsing online)
11 and then Trollop::Parser#opt. Also see the examples at
12 http://trollop.rubyforge.org/.
13
14 == DESCRIPTION
15
16 Trollop is a commandline option parser for Ruby that just gets out of your
17 way. One line of code per option is all you need to write. For that, you get a
18 nice automatically-generated help page, robust option parsing, command
19 subcompletion, and sensible defaults for everything you don't specify.
20
21 == FEATURES/PROBLEMS
22
23 - Dirt-simple usage.
24 - Sensible defaults. No tweaking necessary, much tweaking possible.
25 - Support for long options, short options, short option bundling, and
26   automatic type validation and conversion.
27 - Support for subcommands.
28 - Automatic help message generation, wrapped to current screen width.
29 - Lots of unit tests.
30
31 == REQUIREMENTS
32
33 * A burning desire to write less code.
34
35 == INSTALL
36
37 * gem install trollop
38
39 == LICENSE
40
41 Copyright (c) 2008--2009 William Morgan. Trollop is distributed under the same
42 terms as Ruby.