diff --git a/README.md b/README.md index f05db81..fda6f2e 100644 --- a/README.md +++ b/README.md @@ -8,26 +8,24 @@ https://github.com/douglascrockford/JSON-java
*These tests are a work in progress. Help from interested developers is welcome.*
More coverage is needed, but more importantly, improvements to test quality is needed.
-You will need the following libraries for testing: -Test harness: http://junit.org
-Coverage: http://www.eclemma.org/
-Mockery: https://github.com/mockito/mockito - -Include these libraries in your project: -JSON-Java.jar (make this jar of the files to be tested yourself) -hamcrest-core-1.3.jar (for Junit) -junit-4.12.jar -mockito-all-1.9.5.jar - - Eclipse is the recommended development environment. Run individual tests or JunitTestSuite using *EclEmma Coverage*, or execute the TestRunner application directly.
+You will need the following libraries for testing: +Test harness: http://junit.org
+* hamcrest-core-1.3.jar (for Junit) +* junit-4.12.jar +Mockery: https://github.com/mockito/mockito +* mockito-all-1.9.5.jar +Coverage: http://www.eclemma.org/ (just install the latest in Eclipse)
+JSON-Java.jar (make this jar of the files to be tested yourself) + +*Conventions* Test filenames should consist of the name of the module being tested, with the suffix "Test". For example, Cookie.java is tested by CookieTest.java. When adding a new unit test, don't forget to update JunitTestSuite.java. -The fundamental issues with JSON-Java testing are: +*The fundamental issues with JSON-Java testing are:* * JSONObjects are unordered, making simple string comparison ineffective. * Comparisons via **equals()** is not currently supported. Neither JSONArray nor JSONObject overrride hashCode() or equals(), so comparison defaults to the Object equals(), which is not useful. * Access to the JSONArray and JSONObject internal containers for comparison is not currently available.