Skip to content

Commit 47e0ce2

Browse files
committed
Document build requirements.
1 parent 64ba230 commit 47e0ce2

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,19 @@ If the presence and ordering of the JSON object fields are guaranteed to always
2222
Otherwise, follow the [`IocLoopCompareStringFieldToCharsIf`](systems.comodal.json_iterator/src/jmh/java/systems/comodal/jsoniter/jmh/styles/IocLoopCompareStringFieldToCharsIf.java#L22) style, which enables inversion of control while it iterates over object fields in conjunction with comparing expected field strings against a field character array. The advantage of this strategy is that it avoids constructing Strings for object fields.
2323

2424
If the first character for all of an objects' fields are unique, follow either the [`IocLoopCharIf`](systems.comodal.json_iterator/src/jmh/java/systems/comodal/jsoniter/jmh/styles/IocLoopCharIf.java#L20) or [`IocLoopCharSwitch`](systems.comodal.json_iterator/src/jmh/java/systems/comodal/jsoniter/jmh/styles/IocLoopCharSwitch.java#L20) style. Similar to the style `IocLoopCompareStringFieldToCharsIf`, these styles avoid constructing Strings for object fields.
25+
26+
## Build
27+
28+
[Generate a classic token](https://github.com/settings/tokens) with the `read:packages` scope needed to access
29+
dependencies hosted on GitHub Package Repository.
30+
31+
Add the following properties to `$HOME/.gradle/gradle.properties`.
32+
33+
```gradle.properties
34+
savaGithubPackagesUsername=GITHUB_USERNAME
35+
savaGithubPackagesPassword=GITHUB_TOKEN
36+
```
37+
38+
```shell
39+
./gradlew check
40+
```

0 commit comments

Comments
 (0)