From 5165d0b70a6f69d28dba45dfcb832b70ffcddaf4 Mon Sep 17 00:00:00 2001
From: Contrary <liang.jingchao@zte.com.cn>
Date: Thu, 20 Mar 2025 22:09:36 +0800
Subject: [PATCH] Add build instructions for tests and benchmarks

Signed-off-by: Contrary <liang.jingchao@zte.com.cn>
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 99c97a3..b9d786b 100644
--- a/README.md
+++ b/README.md
@@ -99,6 +99,12 @@ Build 3FS in `build` folder:
     cmake -S . -B build -DCMAKE_CXX_COMPILER=clang++-14 -DCMAKE_C_COMPILER=clang-14 -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
     cmake --build build -j 32
 
+### Build tests && benchmarks
+
+Build `tests` requires you to add the `-DWITH_TESTS` option to the cmake in the first step above.
+
+For `benchmarks`, it's -DWITH_BENCHMARKS.
+
 ## Run a test cluster
 
 Follow instructions in [setup guide](deploy/README.md) to run a test cluster.