From de4395dc5ec1fdc62b81a115a9766cac21695b3b Mon Sep 17 00:00:00 2001 From: stleary Date: Sat, 18 Jul 2020 12:59:34 -0500 Subject: [PATCH] initial commit --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a58954..c99ba12 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,49 @@ package. The package compiles on Java 1.6-1.8. -# With commit [#515 Merge tests and pom and code](https://github.com/stleary/JSON-java/pull/515), the structure of the project has changed from a flat directory containing all of the Java files to a directory structure that includes unit tests. If you have difficulty using the new structure, please open an issue so we can work through it. +** Recently [#515 Merge tests and pom and code](https://github.com/stleary/JSON-java/pull/515), the structure of the project changed from a flat directory containing all of the Java files to a directory structure that includes unit tests and several build tools to build the project jar and run the unit tests. If you have difficulty using the new structure, please open an issue so we can work through it. + +** Building from the command line + +* Build the class files from the package root directory src/main/java + +* * javac org\json\*.java + +* Build the jar file + +* * jar cf json-java.jar org/json/*.class + +* Compile a program that uses the jar (see below example code) + +* * javac -cp .;json-java.jar Test.java + +* Excecute the Test file + +* * java -cp .;json-java.jar Test + + +* Test file contents + +```` +import org.json.JSONObject; +public class Test { + public static void main(String args[]){ + JSONObject jo = new JSONObject("{ \"abc\" : \"def\" }"); + System.out.println(jo.toString()); + } +} +```` + +* Expected output + +```` +{"abc":"def"} +```` + + +You can only run the unit tests with Maven or Gradlew. + +