Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

updating rdoc, fixing requirement list

  • Loading branch information...
commit 0214cd73db1aec91f195d818d9510791f5cbeabe 1 parent 3e54f56
Aaron Patterson authored July 14, 2010

Showing 2 changed files with 23 additions and 3 deletions. Show diff stats Hide diff stats

  1. 25  README.rdoc
  2. 1  Rakefile
25  README.rdoc
Source Rendered
@@ -9,15 +9,34 @@ style and format used for Ruby on Rails API documentation.
9 9
 
10 10
 == FEATURES/PROBLEMS:
11 11
 
12  
-* Not done yet
  12
+* May have bugs?
13 13
 
14 14
 == SYNOPSIS:
15 15
 
16  
-  FIX (code sample of usage)
  16
+You can output Horo formatted documentation from the command line like this:
  17
+
  18
+  $ sudo gem install horo
  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.
17 35
 
18 36
 == REQUIREMENTS:
19 37
 
20  
-* FIX (list of requirements)
  38
+* Ruby
  39
+* RDoc 2.5.x
21 40
 
22 41
 == INSTALL:
23 42
 
1  Rakefile
@@ -8,6 +8,7 @@ Hoe.spec 'horo' do
8 8
   self.readme_file   = 'README.rdoc'
9 9
   self.history_file  = 'CHANGELOG.rdoc'
10 10
   self.extra_rdoc_files  = FileList['*.rdoc']
  11
+  self.extra_deps     << ['rdoc', '~> 2.5']
11 12
   self.extra_dev_deps << ['nokogiri', '>= 1.4.2']
12 13
 end
13 14
 

0 notes on commit 0214cd7

Please sign in to comment.
Something went wrong with that request. Please try again.