Permalink
Browse files

Quick documentation for the check_history tool.

  • Loading branch information...
1 parent 52d5eda commit 71ab29003b06cf63e9eccc59c0b2316b9e8933de @zerebubuth committed May 10, 2012
Showing with 11 additions and 2 deletions.
  1. +11 −2 README.md
View
@@ -7,15 +7,24 @@ this against an `apidb` format database, or possibly a live API.
# Requirements
-To run this, you'll need Ruby (probably >=1.9.3) and the 'text'
-gem, which you can install with `bundle install`. Then you'll be able
+To run this, you'll need Ruby (probably >=1.9.3) and some gems,
+which you can install with `bundle install`. Then you'll be able
to run:
`ruby test.rb`
which will run the full range of unit tests. The test files can also
be individually run to concentrate on some aspects of the suite.
+# Tools
+
+A simple command-line tool, `check_history.rb`, is provided to query
+an API and return information about the actions that the bot would
+execute, if it were running for real. If you find any results from
+this which are not as expected, then they would make good unit
+tests. Run `ruby check_history.rb --help` for more information on
+running the tool, and on the available options.
+
# Test-Driven Development
This code is intended to be read as a test-driven development. It's

0 comments on commit 71ab290

Please sign in to comment.