File tree 2 files changed +27
-1
lines changed
2 files changed +27
-1
lines changed Original file line number Diff line number Diff line change
1
+ # Roku SceneGraph/BrightScript Documentation Generator
2
+
3
+ [ ![ Gem Version] ( https://badge.fury.io/rb/rsg_doc.svg )] ( https://badge.fury.io/rb/rsg_doc )
4
+
5
+ A tool to generate documentation for Brightscript referenced in Scenegraph XML.
6
+
7
+ ## Installation
8
+
9
+ $ gem install rsg_doc
10
+
11
+ ## Usage
12
+
13
+ From within the root directory for a project:
14
+
15
+ $ rsg
16
+
17
+ ### Result
18
+
19
+ Will produce a docs folder with the same directory structure as the project with .brs.html and .xml.html files.
20
+
21
+ ## Contributing
22
+
23
+ 1 . Fork it
24
+ 2 . Create your feature branch (` git checkout -b feature/my-new-feature ` )
25
+ 3 . Commit your changes (` git commit -am 'Add some feature' ` )
26
+ 4 . Push to the branch (` git push origin feature/my-new-feature ` )
27
+ 5 . Create a new Pull Request
Original file line number Diff line number Diff line change 4
4
require "rsg_doc"
5
5
require "byebug"
6
6
7
- puts Dir . pwd ( )
8
7
Docgen . new ( root_dir : Dir . pwd ( ) ) . generate
You can’t perform that action at this time.
0 commit comments