Skip to content

Commit 48a322f

Browse files
committed
Added README.
1 parent 1b29f7c commit 48a322f

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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

bin/rsg

-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@
44
require "rsg_doc"
55
require "byebug"
66

7-
puts Dir.pwd()
87
Docgen.new(root_dir: Dir.pwd()).generate

0 commit comments

Comments
 (0)