From a6f8d48693d043ad04195c32c4241d5a1948a382 Mon Sep 17 00:00:00 2001 From: rjust Date: Mon, 9 Sep 2024 09:20:30 -0700 Subject: [PATCH] Improve README. --- framework/lib/formatter/README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/framework/lib/formatter/README.md b/framework/lib/formatter/README.md index dd14ae09b..d0ace4aef 100644 --- a/framework/lib/formatter/README.md +++ b/framework/lib/formatter/README.md @@ -1,6 +1,10 @@ -# Custom JUnit test formatter that outputs executed and failing tests, following -# Defects4J's naming conventions for test entries. +# Custom JUnit test formatter and test runner -Run ant test to compile and test the formatter implementation. +The custom test runner allows Defects4J to run a single test case. -Run ant jar to build and deploy the `formatter.jar`. +The custom formatter outputs executed and failing tests, following Defects4J's +naming conventions for test entries. + +* Run `ant test` to compile and test the formatter implementation. + +* Run `ant jar` to build and deploy the *formatter.jar*.