From d6c7d9bcec9eceef9780e4e7af90d36d87467ead Mon Sep 17 00:00:00 2001
From: jiacai2050 <dev@liujiacai.net>
Date: Wed, 18 Dec 2024 15:53:02 +0800
Subject: [PATCH] polish README

---
 src/benchmarks/README.md                   | 19 ++++++-------------
 src/benchmarks/{bench.toml => config.toml} |  0
 2 files changed, 6 insertions(+), 13 deletions(-)
 rename src/benchmarks/{bench.toml => config.toml} (100%)

diff --git a/src/benchmarks/README.md b/src/benchmarks/README.md
index edf6a439f3..73cc9d2def 100644
--- a/src/benchmarks/README.md
+++ b/src/benchmarks/README.md
@@ -1,22 +1,15 @@
 # Benchmarks
 
-## Test Data
-todo
+A config template can be found in [here](config.toml).
 
-## Config
-A config template can be found in `config/bench.toml`.
-
-## Run benchmarks
+## How to run
 ```bash
-ANALYTIC_BENCH_CONFIG_PATH=/path/to/bench.toml cargo bench -p benchmarks
+ANALYTIC_BENCH_CONFIG_PATH=/path/to/config cargo bench -p benchmarks
 ```
 
-Print logs:
-```bash
-RUST_LOG=info ANALYTIC_BENCH_CONFIG_PATH=/path/to/bench.toml cargo bench -p benchmarks
-```
+Set `RUST_LOG=debug` to enable verbose log.
 
-Run specific bench:
+## Run specific bench:
 ```bash
-ANALYTIC_BENCH_CONFIG_PATH=/path/to/bench.toml cargo bench --bench bench -p benchmarks -- bench_encoding
+ANALYTIC_BENCH_CONFIG_PATH=/path/to/config cargo bench --bench bench -p benchmarks -- bench_encoding
 ```
diff --git a/src/benchmarks/bench.toml b/src/benchmarks/config.toml
similarity index 100%
rename from src/benchmarks/bench.toml
rename to src/benchmarks/config.toml