Skip to content

Commit daf7485

Browse files
[benchmark] Update documentation to reflect usage of automated script to generate benchmarks
1 parent 1ca47e7 commit daf7485

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

benchmark/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,12 +132,17 @@ Adding New Benchmarks
132132

133133
The harness generator supports both single and multiple file tests.
134134

135-
To add a new single file test:
135+
To add a new single file test, execute the following script with the new of the benchmark:
136136

137+
```
138+
swift-source$ ./swift/benchmark/scripts/create_benchmark.py YourTestNameHere
139+
```
140+
141+
The script will automatically:
137142
1. Add a new Swift file (`YourTestNameHere.swift`), built according to
138143
the template below, to the `single-source` directory.
139-
2. Add the filename of the new Swift file to CMakeLists.txt
140-
3. Edit `main.swift`. Import and register your new Swift module.
144+
2. Add the filename of the new Swift file to `CMakeLists.txt`.
145+
3. Edit `main.swift` by importing and registering your new Swift module.
141146

142147
To add a new multiple file test:
143148

0 commit comments

Comments
 (0)