aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexander Yastrebov <yastrebov.alex@gmail.com>2024-01-05 20:11:11 +0100
committerGunnar Morling <gunnar.morling@googlemail.com>2024-01-05 20:14:07 +0100
commit398926028525362b20f7115e313e40bede630c04 (patch)
tree74c52aa7bda9c741a7bfcdb640cdd57ab7b23f14 /README.md
parent133a89088a5743d2eebbccbc474636b849e0b987 (diff)
Add example of how to use sdk
Diffstat (limited to 'README.md')
-rw-r--r--README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/README.md b/README.md
index 93354ea..ac27ca5 100644
--- a/README.md
+++ b/README.md
@@ -147,6 +147,7 @@ To submit your own implementation to 1BRC, follow these steps:
* Make that implementation fast. Really fast.
* Create a copy of _calculate_average_baseline.sh_, named _calculate\_average\_<your_GH_user>.sh_, e.g. _calculate\_average\_doloreswilson.sh_.
* Adjust that script so that it references your implementation class name. If needed, provide any JVM arguments via the `JAVA_OPTS` variable in that script.
+ Make sure that script does not write anything to standard output other than calculation results.
* OpenJDK 21 is the default. If a custom JDK build is required, include the SDKMAN command `sdk use java [version]` in the launch shell script prior to application start.
* (Optional) If you'd like to use native binaries (GraalVM), adjust the _pom.xml_ file so that it builds that binary.
* Run the test suite by executing _/test.sh <your_GH_user>_; if any differences are reported, fix them before submitting your implementation.