Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 69 lines (46 sloc) 2.041 kb
ef38060 @tenderlove adding initial horo template
authored
1 = horo
2
4d02ccf @tenderlove updating docs
authored
3 * http://github.com/tenderlove/horo
ef38060 @tenderlove adding initial horo template
authored
4
5 == DESCRIPTION:
6
4d02ccf @tenderlove updating docs
authored
7 An RDoc template extracted from Ruby on Rails. Provides the same documetation
8 style and format used for Ruby on Rails API documentation.
ef38060 @tenderlove adding initial horo template
authored
9
10 == FEATURES/PROBLEMS:
11
0214cd7 @tenderlove updating rdoc, fixing requirement list
authored
12 * May have bugs?
ef38060 @tenderlove adding initial horo template
authored
13
14 == SYNOPSIS:
15
0214cd7 @tenderlove updating rdoc, fixing requirement list
authored
16 You can output Horo formatted documentation from the command line like this:
17
72dfb08 @dmarkow Don't use --pre in instructions, which gives you an older beta version.
dmarkow authored
18 $ sudo gem install horo
0214cd7 @tenderlove updating rdoc, fixing requirement list
authored
19 $ cd ~/git/nokogiri
20 $ rdoc -f horo --main README.rdoc *.rdoc lib ext
21
22 Here is an example rake task that uses the Horo format:
23
24 RDoc::Task.new do |rdoc|
25 rdoc.title = "My Awesome docs"
26 rdoc.rdoc_dir = 'doc'
27
28 rdoc.options << '-f' << 'horo'
29 rdoc.options << '--main' << 'README'
30 end
31
32 The important part is that you have the "horo" gem installed and that you pass
33 the "-f horo" option. That tells RDoc to use the Horo format when generating
34 your documentation.
ef38060 @tenderlove adding initial horo template
authored
35
36 == REQUIREMENTS:
37
0214cd7 @tenderlove updating rdoc, fixing requirement list
authored
38 * Ruby
39 * RDoc 2.5.x
ef38060 @tenderlove adding initial horo template
authored
40
41 == INSTALL:
42
dde3e59 @tenderlove updating insall
authored
43 * gem install horo
ef38060 @tenderlove adding initial horo template
authored
44
45 == LICENSE:
46
47 (The MIT License)
48
5bb726d @tenderlove giving credit where credit is due
authored
49 Copyright (c) 2010 Aaron Patterson, Hongli Lai, Jamis Buck, et al.
ef38060 @tenderlove adding initial horo template
authored
50
51 Permission is hereby granted, free of charge, to any person obtaining
52 a copy of this software and associated documentation files (the
53 'Software'), to deal in the Software without restriction, including
54 without limitation the rights to use, copy, modify, merge, publish,
55 distribute, sublicense, and/or sell copies of the Software, and to
56 permit persons to whom the Software is furnished to do so, subject to
57 the following conditions:
58
59 The above copyright notice and this permission notice shall be
60 included in all copies or substantial portions of the Software.
61
62 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
63 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
64 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
65 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
66 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
67 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
68 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.