create_fork.sh: Script to Create a New Fork (#296)

* Script to Create a New Fork

* validate fork name

* use interactive prompt to prevent accidentally overwriting existing fork

* recommend create_fork.sh in the README

* remove mention of additional_builds_steps (obsolete)

---------

Co-authored-by: Jason Nochlin <hundredwatt@users.noreply.github.com>

1 files changed, 7 insertions, 6 deletions

diff --git a/README.md b/README.md
index 94d25f2..feb7e0b 100644
--- a/README.md
+++ b/README.md
@@ -272,13 +272,14 @@ If you want to use a build not available via these channels, reach out to discus
 To submit your own implementation to 1BRC, follow these steps:
 
 * Create a fork of the [onebrc](https://github.com/gunnarmorling/onebrc/) GitHub repository.
-* Create a copy of _CalculateAverage.java_, named _CalculateAverage\_<your_GH_user>.java_, e.g. _CalculateAverage\_doloreswilson.java_.
+* Run `./create_fork.sh <your_GH_user>` to copy the baseline implementation to your personal files, or do this manually:
+  * Create a copy of _CalculateAverage.java_, named _CalculateAverage\_<your_GH_user>.java_, e.g. _CalculateAverage\_doloreswilson.java_.
+  * 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.
+  * (Optional) OpenJDK 21 is used by default. If a custom JDK build is required, create a copy of _prepare\_baseline.sh_, named _prepare\_<your_GH_user>.sh_, e.g. _prepare\_doloreswilson.sh_. Include the SDKMAN command `sdk use java [version]` in the your prepare script.
+  * (Optional) If you'd like to use native binaries (GraalVM), add all the required build logic to your _prepare\_<your_GH_user>.sh_ script.
 * 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.
-* (Optional) OpenJDK 21 is used by default. If a custom JDK build is required, create a copy of _prepare\_baseline.sh_, named _prepare\_<your_GH_user>.sh_, e.g. _prepare\_doloreswilson.sh_. Include the SDKMAN command `sdk use java [version]` in the your prepare script.
-* (Optional) If you'd like to use native binaries (GraalVM), create a script named _additional\_build\_step\_<your_GH_user>.sh_, e.g. _additional\_build\_step\_doloreswilson.sh_ and add all the required build logic there
 * Run the test suite by executing _/test.sh <your_GH_user>_; if any differences are reported, fix them before submitting your implementation.
 * Create a pull request against the upstream repository, clearly stating
   * The name of your implementation class.