Skip to content

Commit

Permalink
Merge pull request #15 from dtcaciuc/docs
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
dtcaciuc authored Mar 7, 2022
2 parents 792e4a7 + 647cfa9 commit 05ad1c3
Showing 1 changed file with 13 additions and 18 deletions.
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
# Grill - interrogate your programs.
A work-in-progress cram-like test runner. (See https://github.com/brodie/cram)
# Grill - Interrogate your programs

Grill is a cram-like test runner (see https://github.com/brodie/cram).
The project aims to provide better performance and independence from Python runtime.

Grill tests are almost exactly like cram tests, and grill should work the same
way as cram in most, but not all, cases.

DONE:
* A command line tool (grill) that can execute tests in grill format.
* Support for regex and glob line matching.
* Shell variables are persisted between commands.

TODO:
* Support cram's environment variables.
* Gradually add support for cram's command-line flags.
* Flesh out the tests for the test.t reader.

WONTFIX:
* PCRE is not supported. Instead, Go's regexp language is.
Notable differences are:
* (re) keyword: PCRE is not supported. Instead, Go's regexp language is.
* (glob) keyword: Use `**` to glob across directory separators.
* Short flags are not supported.

Additional differences:
* glob keyword: Use `**` to glob across directory separators.
Still TODO / under consideration:
* Concurrent test execution
* Interactive mode
* Skipping
* Variable command indent

There are probably lots of bugs at this point, bug reports and test cases would
be appreciated.
Bug reports and test cases are always appreciated!

0 comments on commit 05ad1c3

Please sign in to comment.