From 49ca2c186cd927fe158a5f334f154c211a53c197 Mon Sep 17 00:00:00 2001 From: Mark Nellemann Date: Fri, 17 May 2024 07:53:49 +0000 Subject: [PATCH] Update README.md --- README.md | 56 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index caf93f3..23c4410 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,3 @@ -# jnetperf +# Repository moved -Small utility to measure (single threaded) network performance between two hosts. - -## Requirements - -You need Java (JRE) version 8 or later to run jnetperf. - -## Usage Instructions - -- Install the jnetperf package (*.deb*, *.rpm* or *.jar*) from [Packages](https://git.data.coop/nellemann/jnetperf/packages) or compile from source. -- Run **/opt/jnetperf/bin/jperf**, if installed from package, or as **java -jar /path/to/jnetperf.jar** - -```shell -Usage: jnetperf [-huV] [-l=NUM] [-n=NUM] [-p=NUM] [-t=SEC] (-c=SRV | -s) -For more information visit https://git.data.coop/nellemann/jnetperf - -c, --connect=SRV Connect to remote server (client). - -h, --help Show this help message and exit. - -l, --pkt-len=NUM Packet size in bytes (client) [default: 1432]. - -n, --pkt-num=NUM Number of packets to send (client) [default: 150000]. - -p, --port=NUM Network port [default: 4445]. - -s, --server Run server and wait for client (server). - -t, --runtime=SEC Time to run, supersedes pkt-num (client) [default: 0]. - -u, --udp Use UDP network protocol [default: false]. - -V, --version Print version information and exit. -``` - - -## Examples - -On *host A* run jnetperf as a server waiting for a connection from a client: - -```shell -java -jar jnetperf-x.y.z-all.jar -s -``` - -On *host B* run jnetperf as a client connecting to the server and sending data: - -```shell -java -jar jnetperf-x.y.z-all.jar -c server-ip -``` - - -## Development Information - -You need Java (JDK) version 8 or later to build jnetperf. - - -### Build & Test - -Use the gradle build tool, which will download all required dependencies: - -```shell -./gradlew clean build -``` +Please visit [github.com/mnellemann/jnetperf](https://github.com/mnellemann/jnetperf) \ No newline at end of file