From 5c494d0b5eae5f4e5c333ce6a0c5ee6391b4eb11 Mon Sep 17 00:00:00 2001
From: Niklas Fiekas <niklas.fiekas@sartorius.com>
Date: Sat, 2 Nov 2024 13:56:18 +0100
Subject: [PATCH] document pgo

---
 research/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/research/README.md b/research/README.md
index a36df90..6017827 100644
--- a/research/README.md
+++ b/research/README.md
@@ -76,3 +76,21 @@ min_deviation,max_deviation,default_volatility,tau,first_advantage,rating_period
 The most important part is the `avg_deviance` column, which is indicates
 the predictive power of the rating system with the given parameters
 (lower is better).
+
+PGO
+---
+
+Profile-guided optimization can be used to create a faster `./replay_encounters`
+binary.
+
+```sh
+# Install dependencies
+rustup component add llvm-tools-preview
+cargo install cargo-pgo
+
+# Check dependencies (bolt not needed)
+cargo pgo info
+
+# Build with PGO
+./pgo.sh
+```