Skip to content

Commit 780d6d3

Browse files
committed
Add BUILD, CONTRIBUTORS files
1 parent 6990a72 commit 780d6d3

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

BUILD.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Preamble
2+
3+
All instructions in this file use the Linux (or other Unix) conventions for
4+
build. If you happen to use Windows, replace `./gradlew` with `gradlew.bat`.
5+
6+
## Building instructions
7+
8+
### Gradle usage
9+
10+
You may be fortunate enough that your IDE has Gradle support. Should it not
11+
be the case, first report a bug to your vendor; then refer to the cheat sheet
12+
below:
13+
14+
```
15+
# List the list of tasks
16+
./gradlew tasks
17+
# Build, test the package
18+
./gradlew test
19+
# Install in your local maven repository
20+
./gradlew clean install
21+
```
22+
23+
If you try and play around with Gradle configuration files, in order to be
24+
_really sure_ that your modifications are accounted for, add the
25+
`--recompile-scripts` option before the task name; for instance:
26+
27+
```
28+
./gradlew --recompile-scripts test
29+
```
30+
31+
## Note to Maven users
32+
33+
There exists a possiblity to generate a `pom.xml` (using `./gradlew pom`), which
34+
is there for convenience. However, this is not supported by the author.
35+

CONTRIBUTORS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Randal Watler ([email protected])
2+
3+
* "JSON Diff"
4+

0 commit comments

Comments
 (0)