From 0d3b5c83fedb2ec80d4ac57c195613e938abeec0 Mon Sep 17 00:00:00 2001 From: Jimmy Zelinskie Date: Tue, 17 Feb 2015 13:20:59 -0500 Subject: [PATCH] README: testing subheader of build/install [ci skip] --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 0fdffaf..6d3c4c0 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,24 @@ $ git clone github.com/chihaya/chihaya chihaya/src/github.com/chihaya/chihaya $ godep go install chihaya/src/github.com/chihaya/cmd/chihaya ``` +### Testing + +Chihaya has end-to-end test coverage for announces in addition to unit tests for +isolated components. To run the tests, use: + +```sh +$ cd $GOPATH/src/github.com/chihaya/chihaya +$ godep go test -v ./... +``` + +There is also a set of benchmarks for performance-critical sections of Chihaya. +These can be run similarly: + +```sh +$ cd $GOPATH/src/github.com/chihaya/chihaya +$ godep go test -v ./... -bench . +``` + ## Configuration Copy [`example_config.json`](https://github.com/chihaya/chihaya/blob/master/example_config.json) @@ -72,21 +90,3 @@ The available keys and their default values are as follows: - `include_mem_stats: true` - `verbose_mem_stats: false` - `mem_stats_interval: "5s"` - -## Testing - -Chihaya has end-to-end test coverage for announces in addition to unit tests for -isolated components. To run the tests, use: - -```sh -$ cd $GOPATH/src/github.com/chihaya/chihaya -$ godep go test -v ./... -``` - -There is also a set of benchmarks for performance-critical sections of Chihaya. -These can be run similarly: - -```sh -$ cd $GOPATH/src/github.com/chihaya/chihaya -$ godep go test -v ./... -bench . -```