Skip to content

Commit 75dcd0d

Browse files
committed
merge supported tools sections into one
1 parent f0d7aea commit 75dcd0d

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,22 @@ and monitor the results on GitHub Actions workflow.
1919

2020
## Supported tools
2121

22-
This action currently supports the following tools:
23-
24-
- [`cargo bench`][cargo-bench] for Rust projects
25-
- `go test -bench` for Go projects
26-
- [benchmark.js][benchmarkjs] for JavaScript/TypeScript projects
27-
- [pytest-benchmark][] for Python projects with [pytest][]
28-
- [Google Benchmark Framework][google-benchmark] for C++ projects
29-
- [Catch2][catch2] for C++ projects
30-
- [BenchmarkTools.jl][] for Julia packages
31-
- [Benchmark.Net][benchmarkdotnet] for .Net projects
32-
- [benchmarkluau](https://github.com/Roblox/luau/tree/master/bench) for Luau projects
22+
This action currently supports the following tools. Please read the README file in each example directory.
23+
24+
- [`cargo bench`][cargo-bench] for Rust projects. [Example setup](https://github.com/benchmark-action/github-action-benchmark/blob/master/examples/rust/README.md)
25+
- `go test -bench` for Go projects. [Example setup](https://github.com/benchmark-action/github-action-benchmark/blob/master/examples/go/README.md)
26+
- [benchmark.js][benchmarkjs] for JavaScript/TypeScript projects. [Example setup](https://github.com/benchmark-action/github-action-benchmark/blob/master/examples/benchmarkjs/README.md)
27+
- [pytest-benchmark][] for Python projects with [pytest][]. [Example setup](https://github.com/benchmark-action/github-action-benchmark/blob/master/examples/benchmarkjs/README.md)
28+
- [Google Benchmark Framework][google-benchmark] for C++ projects. [Example setup](https://github.com/benchmark-action/github-action-benchmark/blob/master/examples/cpp/README.md)
29+
- [Catch2][catch2] for C++ projects. [Example setup](https://github.com/benchmark-action/github-action-benchmark/blob/master/examples/cpp/README.md)
30+
- [BenchmarkTools.jl][] for Julia packages. [Example setup](https://github.com/benchmark-action/github-action-benchmark/blob/master/examples/julia/README.md)
31+
- [Benchmark.Net][benchmarkdotnet] for .Net projects. [Example setup](https://github.com/benchmark-action/github-action-benchmark/blob/master/examples/benchmarkdotnet/README.md)
32+
- [benchmarkluau](https://github.com/Roblox/luau/tree/master/bench) for Luau projects. [Example setup](https://github.com/benchmark-action/github-action-benchmark?tab=readme-ov-file#)
3333
- [JMH][jmh] for Java projects
3434
- Custom benchmarks where either 'biggerIsBetter' or 'smallerIsBetter'
3535

36-
Multiple languages in the same repository are supported for polyglot projects.
36+
Multiple languages in the same repository are supported for polyglot projects.. Usually, take stdout from a benchmark tool and store it to file. Then specify the file path to output-file-path input.
37+
3738

3839
[Japanese Blog post](https://rhysd.hatenablog.com/entry/2019/11/11/131505)
3940

0 commit comments

Comments
 (0)