summaryrefslogtreecommitdiff
path: root/ruby
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2018-09-06 00:28:33 -0400
committerPaul Duncan <pabs@pablotron.org>2018-09-06 00:28:33 -0400
commit384599d12a3d8902eae483d20761d995f44980bf (patch)
tree0238a2060347ce0627d949baeb8a156903881c44 /ruby
parent74e86d266b244ff40c098dfabab239710c6e5143 (diff)
downloadluigi-template-384599d12a3d8902eae483d20761d995f44980bf.tar.bz2
luigi-template-384599d12a3d8902eae483d20761d995f44980bf.zip
ruby/README.mkd: updates
Diffstat (limited to 'ruby')
-rw-r--r--ruby/README.mkd28
1 files changed, 28 insertions, 0 deletions
diff --git a/ruby/README.mkd b/ruby/README.mkd
index d3ae750..790ea05 100644
--- a/ruby/README.mkd
+++ b/ruby/README.mkd
@@ -20,6 +20,30 @@ The API documentation is available online at the following URL:
https://pablotron.github.io/luigi-template/ruby/
+You can generate the API documentation in the `docs/` directory via
+[RDoc][], like so:
+
+ # generate API documentation in docs/ directory
+ rake docs
+
+Tests
+-----
+You can run the [minitest][] test suite via [Rake][], like so:
+
+ # run the test suite
+ rake test
+
+To generate a [JUnit][]-compatible XML report, install the
+[minitest-junit][] gem and then do the following:
+
+ # run the test suite and generate a junit-compatible report.xml
+ rake test TESTOPTS=--junit
+
+Author
+------
+Paul Duncan ([pabs@pablotron.org][me])<br/>
+https://pablotron.org/
+
License
-------
Copyright 2007-2018 Paul Duncan ([pabs@pablotron.org][me])
@@ -44,3 +68,7 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[me]: mailto:pabs@pablotron.org
+[minitest]: https://github.com/seattlerb/minitest
+[minitest-junit]: https://github.com/aespinosa/minitest-junit
+[RDoc]: https://github.com/ruby/rdoc
+[Rake]: https://github.com/ruby/rake