Permalink
Browse files

Fix typo in README. [doc]

  • Loading branch information...
1 parent 8a69c72 commit a0075479c51d8289b411bfed53765a6bb10c1981 @trans trans committed Feb 1, 2012
Showing with 9 additions and 8 deletions.
  1. +9 −8 README.rdoc
View
@@ -1,6 +1,7 @@
= TAPOUT
{Website}[http://rubyworks.github.com/tapout] |
+{User Guide}[http://github.com/rubyworks/tapout/wiki] |
{Development}[http://github.com/rubyworks/tapout] |
{Report Issue}[http://github.com/rubyworks/tapout/issues]
@@ -10,12 +11,12 @@
== DESCRIPTION
*TAPOUT* is a TAP handler which supports TAP-Y/J as well as traditional TAP streams.
-
TAP-Y/J is a modernization of TAP using pure YAML/JSON streams.
+
Traditional TAP has less detail than TAP-Y/J, but it can still be translated
with fairly good results. TAPOUT includes a TAP adapter to handle the
-translation transparently. Currently TAPOUT supports TAP v12 with minor
-some limitations.
+translation transparently. Currently TAPOUT supports TAP v12 with some minor
+limitations.
To learn about the TAP-Y/J specification, see the {TAP-Y/J Specification}[https://github.com/rubyworks/tapout/wiki/Specification]
document.
@@ -28,17 +29,17 @@ For information about TAP, see http://testanything.org/wiki/index.php/Main_Page.
Using a test framework that produces a TAP-Y output stream, simply pipe
the stream into `tapout`.
- $ ruby-test -y -Ilib test/foo.rb | tapout
+ $ rubytest -y -Ilib test/foo.rb | tapout
TAPOUT supports a variety of output formats. These are selectable via the
first argument. The default if not given, as in the example above, is `dotprogress`.
- $ ruby-test -y -Ilib test/foo.rb | tapout progessbar
+ $ rubytest -y -Ilib test/foo.rb | tapout progessbar
TAPOUT is smart enough to match the closest matching format name. So, for
example, the above could be written as:
- $ ruby-test -y -Ilib test/foo.rb | tapout pro
+ $ rubytest -y -Ilib test/foo.rb | tapout pro
And tapout will know to use the `progressbar` format.
@@ -49,14 +50,14 @@ To see a list of supported formats use the list subcommand:
If your test framework does not support TAP-Y, but does support traditional
TAP, TAPOUT will automatically recognize the difference by TAP's `1..N` header.
- $ ruby-test -ftap -Ilib test/foo.rb | tapout progressbar
+ $ rubytest -ftap -Ilib test/foo.rb | tapout progressbar
== COPYRIGHTS
TAPOUT - Copyright (c) 2010 Rubyworks
-TAPOUT is licensed under the terms of the *BSD-2-Clause* license.
+TAPOUT is distributable in accordance with the *BSD-2-Clause* license.
See COPYING.rdoc for details.

0 comments on commit a007547

Please sign in to comment.