From eb304059ccaeee3c13f8d59944219a50d2f4053d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Frosteg=C3=A5rd?= Date: Tue, 2 Nov 2021 16:13:50 +0100 Subject: [PATCH] README: mention enabling CPU extensions --- README.md | 5 +++++ TODO.md | 1 - 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aba8e9b..97f7b28 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,11 @@ of sub-implementations for different protocols: Compile the implementations that you are interested in: ```sh +# Tell Rust to enable support for all CPU extensions present on current CPU +# except for those relating to AVX-512. This is necessary for aquatic_ws and +# recommended for the other implementations. +. ./scripts/env-native-cpu-without-avx-512 + cargo build --release -p aquatic_udp cargo build --release -p aquatic_udp --features "with-glommio" --no-default-features cargo build --release -p aquatic_http diff --git a/TODO.md b/TODO.md index cd63abb..71cea43 100644 --- a/TODO.md +++ b/TODO.md @@ -1,7 +1,6 @@ # TODO * readme - * add avx2 env script to readme * document privilige dropping, cpu pinning * config: fail on unrecognized keys