Update documentation for latest changes. [doc]

Author: trans

HISTORY.md

@@ -1,5 +1,34 @@
 # RELEASE HISTORY
 
+## 0.6.0 / 2013-02-10
+
+This release of Ruby Test takes a hard step back and reconsiders how
+to handle configuration from the ground up. Current users of Ruby Test
+will probably have to make some adjustments. Our apologies for the extra
+work. But the whole thing simply got more complicated than it needed to
+be and it was decided that conventional simplicity, with the option 
+unconventional complexity, was the best approach.
+
+So, to make a long story short. There is no default config file anymore.
+The `-p/--profile` command line option has been removed; replaced by
+a `-c/--config` option which simply requires a file relative to the current
+project. In addition the configuration API had been changed from `Test.run`
+or `Test.configure`, to adopt the common convention. And it no longer takes
+a profile name for an argument. `Test.run` still has the same interface as
+`Test.configure` but it will now run tests immediately! So be sure to change
+that if you used it the past. Lastly, Ruby Test now supports DotOpts out of
+the box, so its easier then ever to setup default command line options.
+
+Changes:
+
+* Rename `Test.run` to `Test.configure` and remove profile argument.
+* Add new `Test.run` to immediately run tests.
+* Add `-c/--config` option for requiring project file.
+* Add built-in support for DotOpts.
+* Deprecate profiles, removing `-p/--profile` cli option.
+* Deprecate Test::Runner configuration class methods.
+
+
 ## 0.5.4 / 2013-01-22
 
 This release simply updates configuraiton code to work with RC v0.4.0.

README.md

@@ -48,34 +48,47 @@ See the [Wiki](http://github.com/rubyworks/test/wiki) for further details.
 
 ## Usage
 
-There are a few ways to run tests. First, there is a command line tool:
+There are a few ways to run tests. First, there is the command line tool
+e.g.
 
-    $ rubytest
+    $ rubytest test/test_*.rb
 
-The command line tool takes various options, use `--help` to see them.
-Be sure to load in your test framework or framework's Ruby Test adapter.
+The command line tool takes various options, use `-h/--help` to see them.
 
-Preconfigurations can be defined in a `.test` file, e.g.
+When running tests, you need to be sure to load in your test framework
+or your framework's RubyTest adapter. This is usually done via a helper
+script in the test files, but might also be done via command line options,
+e.g.
 
-    Test.run 'default' do |r|
-      r.format = 'progress'
-      r.requires << 'lemon'
-      r.files << 'test/*_case.rb'
-    end
+    $ rubytest -r lemon -r ae test/test_*.rb
 
-There is also a 'rubytest/autorun.rb' library script that can be loaded which
-creates an `at_exit` runner, for which `test.rb` provides a nice shortcut:
+RubyTest supports [dotopts](http://rubyworks.github.com/dotopts) out of the
+box, so it easy to setup reusable options. For example, a `.option` file
+entry might be:
 
-    $ ruby -r test
+    rubytest
+      -f progress
+      -r spectroscope
+      -r rspecial
+      spec/spec_*.rb
 
-There is also a Rake task.
+There is also a Rake task. In your Rakefile,
 
     require 'rubytest/rake'
 
-    Test::Rake::TestTask.new
+    Test::Rake::TestTask.new do |run|
+      require 'lemon'
+      run.files << 'test/test_*.rb'
+    end
 
 A Detroit plugin is in the works and should be available soon.
 
+See the Wiki for more information on the different ways to run tests.
+
+
+Notice the use of `Test.configure` which is .
+
+
 
 ## Installation
 

lib/rubytest/config.rb

@@ -134,9 +134,12 @@ def files
       @files ||= []
     end
 
+    # Format by default is `dotprogress`. The format can also be set
+    # via the `RUBYTEST_FORMAT` environment variable.
     #
+    # @return [String] format
     def format
-      @format || DEFAULT_FORMAT
+      @format || ENV['RUBYTEST_FORMAT'] || DEFAULT_FORMAT
     end
 
     #
@@ -169,22 +172,22 @@ def units
       @unit ||= []
     end
 
-    #
+    # Hard is a synonym for assertionless.
     def hard
-      @hard
+      @hard || Runner.assertionless
     end
 
-    #
+    # Hard is a synonym for assertionless.
     def hard=(boolean)
       @hard = !!boolean
     end
 
-    #
+    # Automatically modify the `$LOAD_PATH`?
     def autopath
       @autopath
     end
 
-    #
+    # Automatically modify the `$LOAD_PATH`?
     def autopath=(boolean)
       @autopath = !!boolean
     end