/
README.txt
45 lines (29 loc) · 1.18 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
= \RDoc - Ruby Documentation System
* {RDoc Project Page}[https://github.com/rdoc/rdoc/]
* {RDoc Documentation}[http://rdoc.rubyforge.org/]
* {RDoc Bug Tracker}[https://github.com/rdoc/rdoc/issues]
== DESCRIPTION:
RDoc produces HTML and command-line documentation for Ruby projects. RDoc
includes the +rdoc+ and +ri+ tools for generating and displaying online
documentation.
See RDoc for a description of RDoc's markup and basic use.
== SYNOPSIS:
To generate HTML documentation:
rdoc .
To generate documentation programmatically:
gem 'rdoc'
require 'rdoc/rdoc'
# ... see RDoc
== BUGS:
If you find a bug, please report it at the RDoc project's
tracker[http://rubyforge.org/tracker/?group_id=627] on RubyForge
== LICENSE:
RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
Portions (c) 2007-2010 Eric Hodel. Portions copyright others, see individual
files for details.
It is free software, and may be redistributed under the terms specified in
LICENSE.txt.
== WARRANTY:
This software is provided "as is" and without any express or implied
warranties, including, without limitation, the implied warranties of
merchantibility and fitness for a particular purpose.