Add README and script to build docs in development

BaseSecrete · Oct 14, 2024 · c6fd922 · c6fd922
1 parent 43280b7
commit c6fd922
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# RorVsWild theme for RDoc
+
+## Usage
+
+```
+gem install rorvswild_theme_rdoc
+rdoc --root path/source/code --template=rorvswild
+```
+
+## Development
+
+Call the custom `rdoc.rb` script which automatically loads RorVsWild'd theme.
+
+```
+./rdoc.rb --root path/source/code --template rorvswild
+```
diff --git a/rdoc.rb b/rdoc.rb
@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.prepend(File.expand_path(File.dirname(__FILE__)) + "/lib")
+
+require "rdoc"
+require "rorvswild_theme_rdoc"
+
+RDoc::RDoc.new.document(ARGV)