Upstream
/
Waterfall
mirror of https://github.com/PaperMC/Waterfall.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README to use the temporary CI

This commit is contained in:
Jamie Mansfield 2016-12-09 18:51:02 +00:00 committed by GitHub
parent 01a2b2f3e1
commit 1d815c9bb9
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,12 +1,13 @@
# Waterfall [![Build Status](https://ci.aquifermc.org/job/Waterfall/badge/icon)](https://ci.aquifermc.org/job/Waterfall/)
Waterfall [![Build Status](https://ci.destroystokyo.com/job/Waterfall/badge/icon)](https://ci.destroystokyo.com/job/Waterfall/)
=========
Waterfall is a fork of the well-known [BungeeCord](https://github.com/SpigotMC/BungeeCord) server teleportation suite.
Waterfall focuses on three main areas:
* **Stability**: Waterfall aims to be stable. We will achieve this through making the code base testable and discouraging practices that lead to proxy lag.
* **Features**: Waterfall aims to include more features than canonical BungeeCord.
* **Scalability**: Waterfall should be able to handle a large number of concurrent players, given a reasonably modern CPU, memory, and good network connection.
- **Stability**: Waterfall aims to be stable. We will achieve this through making the code base testable and discouraging practices that lead to proxy lag.
- **Features**: Waterfall aims to include more features than canonical BungeeCord.
- **Scalability**: Waterfall should be able to handle a large number of concurrent players, given a reasonably modern CPU, memory, and good network connection.
## Why fork BungeeCord?
@ -17,26 +18,26 @@ 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/)
## How To (Server Admins)
Download a copy of Waterfall.jar from our buildserver here: [Waterfall](https://ci.destroystokyo.com/job/Waterfall/)
Waterfall requires **Java 8** or above.
How To (Compiling From Source)
------
## 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/
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.
* Join us on IRC (irc.esper.net #waterfall, [webchat](http://webchat.esper.net/?nick=&channels=waterfall)).
* Join us on IRC (irc.spi.gt #waterfall, [webchat](http://hansel.spi.gt/iris/?nick=&channels=waterfall)).
* Visit our forums on [Aquifer](https://aquifermc.org).
Special Thanks To
-----------------
## Special Thanks To
![YourKit-Logo](https://yourkit.com/images/yklogo.png)
[YourKit](https://yourkit.com/), makers of the outstanding Java profiler, supports open source projects of all kinds with their full-featured [Java](https://yourkit.com/features/) and [.NET](https://yourkit.com/dotnet/features/) application profilers. We thank them for granting Waterfall an OSS license so that we can make our software the best it can be.