Skip to content

Commit 79ff79e

Browse files
committed
initial commit
1 parent d14c7b9 commit 79ff79e

1 file changed

Lines changed: 14 additions & 19 deletions

File tree

README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The files in this package implement JSON encoders/decoders in Java.
1212
It also includes the capability to convert between JSON and XML, HTTP
1313
headers, Cookies, and CDL.
1414

15-
This is a reference implementation. There is a large number of JSON packages
15+
This is a reference implementation. There are a large number of JSON packages
1616
in Java. Perhaps someday the Java community will standardize on one. Until
1717
then, choose carefully.
1818

@@ -22,28 +22,28 @@ package.
2222

2323
The package compiles on Java 1.6-1.8.
2424

25-
**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.
25+
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.
2626

27-
**Building from the command line
27+
**Building from the command line**
2828

29-
* Build the class files from the package root directory src/main/java
29+
*Build the class files from the package root directory src/main/java*
3030

3131
* * javac org\json\*.java
3232

33-
*Build the jar file
33+
*Build the jar file*
3434

3535
* * jar cf json-java.jar org/json/*.class
3636

37-
*Compile a program that uses the jar (see below example code)
37+
*Compile a program that uses the jar (see below example code)*
3838

3939
* * javac -cp .;json-java.jar Test.java
4040

41-
*Excecute the Test file
41+
*Excecute the Test file*
4242

4343
* * java -cp .;json-java.jar Test
4444

4545

46-
*Test file contents
46+
*Test file contents*
4747

4848
````
4949
import org.json.JSONObject;
@@ -55,22 +55,17 @@ public class Test {
5555
}
5656
````
5757

58-
* Expected output
58+
*Expected output*
5959

6060
````
6161
{"abc":"def"}
6262
````
6363

6464

65-
*You can only run the unit tests with Maven or Gradlew.
65+
*You can only run the unit tests with Maven or Gradlew.*
6666

67-
* * mvn clean test
6867

69-
* * gradlew clean test
70-
71-
72-
73-
**Files
68+
#Files
7469

7570
**JSONObject.java**: The `JSONObject` can parse text from a `String` or a `JSONTokener`
7671
to produce a map-like object. The object provides methods for manipulating its
@@ -199,11 +194,11 @@ https://search.maven.org/search?q=g:org.json%20AND%20a:json&core=gav
199194
# Unit tests
200195
The test suite can be executed with Maven by running:
201196
```
202-
mvn test
197+
mvn clean test
203198
```
204-
The test suite can be executed with Gradle (6.4 or greater) by running:
199+
The test suite can be executed with Gradlew by running:
205200
```
206-
gradle clean build test
201+
gradlew clean build test
207202
```
208203

209204

0 commit comments

Comments
 (0)