From 7d4ba6940bd3eeed36978ccffcc949eb5ea5b406 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Frosteg=C3=A5rd?= Date: Sat, 27 Jan 2024 17:46:49 +0100 Subject: [PATCH] Improve README files --- README.md | 6 +++--- crates/http/README.md | 18 +++++++++++------- crates/udp/README.md | 15 +++++++++------ crates/ws/README.md | 17 +++++++++++------ 4 files changed, 34 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 96134f7..9621f8c 100644 --- a/README.md +++ b/README.md @@ -46,10 +46,10 @@ the table above. ## Copyright and license -Copyright (c) 2020-2023 Joakim Frostegård +Copyright (c) Joakim Frostegård -Distributed under the terms of the Apache 2.0 license. Please refer to the -`LICENSE` file in the repository root directory for details. +Distributed under the terms of the Apache License, Version 2.0. Please refer to +the `LICENSE` file in the repository root directory for details. ## Trivia diff --git a/crates/http/README.md b/crates/http/README.md index 7895386..1ae902d 100644 --- a/crates/http/README.md +++ b/crates/http/README.md @@ -25,10 +25,11 @@ More benchmark details are available [here](../../documents/aquatic-http-load-te - Install Rust with [rustup](https://rustup.rs/) (latest stable release is recommended) - Install cmake with your package manager (e.g., `apt-get install cmake`) -- Clone this git repository and enter its root directory -- Build the application: +- Clone this git repository and build the application: ```sh +git clone https://github.com/greatest-ape/aquatic.git && cd aquatic + # Recommended: tell Rust to enable support for all SIMD extensions present on # current CPU except for those relating to AVX-512. (If you run a processor # that doesn't clock down when using AVX-512, you can enable those instructions @@ -51,7 +52,8 @@ Make necessary adjustments to the file. You will likely want to adjust `address` To run over TLS, configure certificate and private key files. -Running behind a reverse proxy is supported. +Running behind a reverse proxy is supported. Please refer to the config file +for details. ### Running @@ -83,7 +85,9 @@ configuration files in a similar manner to the tracker application. After starting the tracker, run the load tester: ```sh -./scripts/run-load-test-http.sh +. ./scripts/env-native-cpu-without-avx-512 # Optional + +cargo build --release -p aquatic_http_load_test -- --help ``` ## Details @@ -107,7 +111,7 @@ fine in production. ## Copyright and license -Copyright (c) 2020-2023 Joakim Frostegård +Copyright (c) Joakim Frostegård -Distributed under the terms of the Apache 2.0 license. Please refer to the -`LICENSE` file in the repository root directory for details. +Distributed under the terms of the Apache License, Version 2.0. Please refer to +the `LICENSE` file in the repository root directory for details. diff --git a/crates/udp/README.md b/crates/udp/README.md index 6183c1b..20ab779 100644 --- a/crates/udp/README.md +++ b/crates/udp/README.md @@ -31,10 +31,11 @@ More benchmark details are available [here](../../documents/aquatic-udp-load-tes - Install Rust with [rustup](https://rustup.rs/) (latest stable release is recommended) - Install cmake with your package manager (e.g., `apt-get install cmake`) -- Clone this git repository and enter its root directory -- Build the application: +- Clone this git repository and build the application: ```sh +git clone https://github.com/greatest-ape/aquatic.git && cd aquatic + # Recommended: tell Rust to enable support for all SIMD extensions present on # current CPU except for those relating to AVX-512. (If you run a processor # that doesn't clock down when using AVX-512, you can enable those instructions @@ -73,7 +74,9 @@ configuration files in a similar manner to the tracker application. After starting the tracker, run the load tester: ```sh -./scripts/run-load-test-udp.sh +. ./scripts/env-native-cpu-without-avx-512 # Optional + +cargo build --release -p aquatic_udp_load_test -- --help ``` ## Details @@ -85,7 +88,7 @@ Implements [BEP 015](https://www.bittorrent.org/beps/bep_0015.html) ([more detai ## Copyright and license -Copyright (c) 2020-2023 Joakim Frostegård +Copyright (c) Joakim Frostegård -Distributed under the terms of the Apache 2.0 license. Please refer to the -`LICENSE` file in the repository root directory for details. +Distributed under the terms of the Apache License, Version 2.0. Please refer to +the `LICENSE` file in the repository root directory for details. diff --git a/crates/ws/README.md b/crates/ws/README.md index 19e61f2..b6bb63e 100644 --- a/crates/ws/README.md +++ b/crates/ws/README.md @@ -29,10 +29,11 @@ More details are available [here](../../documents/aquatic-ws-load-test-2023-01-2 - Install Rust with [rustup](https://rustup.rs/) (latest stable release is recommended) - Install cmake with your package manager (e.g., `apt-get install cmake`) -- Clone this git repository and enter its root directory -- Build the application: +- Clone this git repository and build the application: ```sh +git clone https://github.com/greatest-ape/aquatic.git && cd aquatic + # Recommended: tell Rust to enable support for all SIMD extensions present on # current CPU except for those relating to AVX-512. (If you run a processor # that doesn't clock down when using AVX-512, you can enable those instructions @@ -53,6 +54,8 @@ Generate the configuration file: Make necessary adjustments to the file. You will likely want to adjust `address` (listening address) under the `network` section. +To run over TLS, configure certificate and private key files. + Running behind a reverse proxy is supported, as long as IPv4 requests are proxied to IPv4 requests, and IPv6 requests to IPv6 requests. @@ -86,7 +89,9 @@ configuration files in a similar manner to the tracker application. After starting the tracker, run the load tester: ```sh -./scripts/run-load-test-ws.sh +. ./scripts/env-native-cpu-without-avx-512 # Optional + +cargo build --release -p aquatic_ws_load_test -- --help ``` ## Details @@ -102,8 +107,8 @@ fine in production. ## Copyright and license -Copyright (c) 2020-2023 Joakim Frostegård +Copyright (c) Joakim Frostegård -Distributed under the terms of the Apache 2.0 license. Please refer to the -`LICENSE` file in the repository root directory for details. +Distributed under the terms of the Apache License, Version 2.0. Please refer to +the `LICENSE` file in the repository root directory for details.