diff --git a/README.md b/README.md index 171254b..4e232c5 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,18 @@ the ecosystem by allowing changes to be exposed to a wider audience more quickly Waterfall will still track upstream BungeeCord and merge changes as needed. +How To (Server Admins) +------ +Download a copy of Waterfall.jar from our buildserver here: [Waterfall](https://ci.aquifermc.org/job/Waterfall/) + +Waterfall requires **Java 8** or above. + +How To (Compiling From Source) +------ +To compile Waterfall, you need JDK8, git, bash, maven, and an internet connection. + +Clone this repo, run ./build.sh from *bash*, get jar from Waterfall-Proxy/bootstrap/target/ + ## Join us * Feel free to open a PR! We accept contributions. diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..f96f637 --- /dev/null +++ b/build.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash + +git submodule update --init && ./applyPatches.sh && pushd Waterfall-Proxy && mvn clean package && popd +