Skip to content

Commit 9d8258d

Browse files
committed
fix: update benchmark tests instructions for clarity and add missing command line options
1 parent 21d9909 commit 9d8258d

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,7 @@ Tests are buildable and runnable from the command line using the `dotnet` CLI an
135135

136136
## Benchmark Tests
137137

138-
The benchmark tests project is in the `benchmarks` directory. It uses BenchmarkDotNet v0.13.8. Benchmarks are buildable and
139-
runnable from the command line using the `dotnet` CLI.
138+
The benchmark tests project is in the `benchmarks` directory. It uses BenchmarkDotNet Benchmarks are buildable and runnable from the command line using the `dotnet` in **Release** configuration.
140139

141140
- Command line:
142141

@@ -155,15 +154,21 @@ runnable from the command line using the `dotnet` CLI.
155154
- Run the benchmarks standalone (Linux/macOS):
156155

157156
```bash
158-
benchmarks/Ulid.Benchmarks/bin/Release/net10.0/Ulid.Benchmarks
157+
benchmarks/Ulid.Benchmarks/bin/Release/net10.0/Ulid.Benchmarks --filter '*' --join --exporters json markdown --memory
159158
```
160159

161160
- Run the benchmarks standalone (Windows):
162161

163162
```bash
164-
benchmarks/Ulid.Benchmarks/bin/Release/net10.0/Ulid.Benchmarks.exe
163+
benchmarks/Ulid.Benchmarks/bin/Release/net10.0/Ulid.Benchmarks.exe --filter '*' --join --exporters json markdown --memory
165164
```
166165

166+
- You can also use the Bash script `run-benchmarks.sh` from the `vm2.DevOps` repository to run the benchmarks, e.g.:
167+
168+
```bash
169+
bash vm2.DevOps/.github/scripts/run-benchmarks.sh $VM2_REPOS/vm2.Ulid/benchmarks/Ulid/Ulid.Benchmarks.csproj
170+
```
171+
167172
## Build and Run the Example
168173

169174
The example is a file-based application `GenerateUlids.cs` in the `examples` directory. It demonstrates basic usage of the

0 commit comments

Comments
 (0)