From 098cd51ab730721c19bb4d7d172e3c203901a062 Mon Sep 17 00:00:00 2001 From: Yorick Peterse Date: Wed, 20 May 2015 23:32:52 +0200 Subject: [PATCH] Notes on how to run benchmarks --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae2ab49..97dedd2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,6 +46,14 @@ You can compile the various parsers/extensions by running: For more information about the available tasks, run `rake -T`. +## Running Benchmarks + +Benchmarks are located in the `benchmark` directory. Some of these require +fixture files which can be generated by running `rake fixtures`. Running a +benchmark is just a matter of running a Ruby script, for example: + + ruby benchmark/xml/parser/parser_bench.rb + ## Continuous Integration Two continuous integration services are used to ensure the tests of Oga pass