branch: elpa/with-simulated-input
commit 570134798783b279a291a5a3a6d1c7bcd236b512
Author: Ryan C. Thompson <[email protected]>
Commit: Ryan C. Thompson <[email protected]>
Update the readme with new instructions for running tests
---
README.md | 39 +++++++++++++++++++++++++++++++++------
1 file changed, 33 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index c7cb9208d5..08b6d2d42c 100644
--- a/README.md
+++ b/README.md
@@ -29,15 +29,42 @@ This package comes with a test suite. If you want to run it
yourself,
first install the [cask](http://cask.readthedocs.io/en/latest/)
dependency manager. Then, from the package directory, run `cask
install` to install all the development dependencies, in
-particular [ert-runner](https://github.com/rejeep/ert-runner.el).
-Finally, to run the tests, execute `cask exec ert-runner`. You should
-see something like this:
+particular
+[buttercup](https://github.com/jorgenschaefer/emacs-buttercup).
+Finally, to run the tests, execute `cask exec buttercup -L .`. You
+should see something like this:
```
-$ cask exec ert-runner
-.
+$ cask exec buttercup -L .
+Running 17 specs.
-Ran 1 test in 0.015 seconds
+`with-simulated-input'
+ should work for basic string input
+ should throw an error if the input is incomplete
+ should allow the input to trigger errors
+ should ignore extra input after BODY has completed
+ should allow multiple functions in BODY to read input
+ should allow aborting via C-g in KEYS
+ used with `completing-read'
+ should work with unambiguous tab completion
+ should work with ambiguous tab completion
+ should fail to exit with ambiguous completion and `require-match'Making
completion list...
+
+ should fail to exit with ambiguous completion and `require-match'
+ using lisp forms in KEYS argument of `with-simulated-input'
+ should allow evaluating arbitrary lisp forms
+ should allow lisp forms to throw errors
+ should not interpret lisp forms once BODY has finished
+
+`wsi-simulate-idle-time'
+ should run idle timers
+ should not run idle times with longer times
+ should run idle timers added by other idle timers
+ should run idle timers added by other idle timers when the new timer is in
the past
+ used within `with-simulated-input'
+ should allow idle timers to trigger during simulated input
+
+Ran 17 specs, 0 failed, in 0.6 seconds.
````
Please run the tests before submitting any pull requests, and note in
