diff --git a/README.md b/README.md index ddbf0d74..83f01d79 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -[![CircleCI](https://circleci.com/gh/DataDog/dd-opentracing-cpp/tree/master.svg?style=svg)](https://circleci.com/gh/DataDog/dd-opentracing-cpp/tree/master) - # Datadog OpenTracing C++ Client +[![CircleCI](https://circleci.com/gh/DataDog/dd-opentracing-cpp/tree/master.svg?style=svg)](https://app.circleci.com/pipelines/github/DataDog/dd-opentracing-cpp?branch=master) + ## Usage Usage docs are on the main Datadog website: @@ -22,7 +22,8 @@ Before considering contributions to the project, please take a moment to read ou ### Dependencies Building this project requires the following tools installed: -- Build tools (eg. `build-essential`, xcode) + +- Build tools (e.g. `build-essential`, xcode) - `cmake` >= 3.1 Additional libraries are installed via a script. @@ -30,47 +31,49 @@ Additional libraries are installed via a script. ### Build Steps - Clone the repository -``` -git clone https://github.com/DataDog/dd-opentracing-cpp -``` + ```sh + git clone https://github.com/DataDog/dd-opentracing-cpp + ``` - Install additional library dependencies (requires `sudo`) -``` -cd dd-opentracing-cpp -sudo scripts/install_dependencies.sh -``` -- Generate build files using cmake -``` -mkdir .build -cd .build -cmake .. -``` + ```sh + cd dd-opentracing-cpp + sudo scripts/install_dependencies.sh + ``` +- Generate build files using `cmake` + ```sh + mkdir .build + cd .build + cmake .. + ``` - Run the build -``` -make -``` + ```sh + make + ``` - (Optional) Run the tests -``` -cmake -DBUILD_TESTING=ON .. -make -ctest --output-on-failure -``` -- (Optional) Install in `/usr/local` -``` -make install -``` + ```sh + cmake -DBUILD_TESTING=ON .. + make + ctest --output-on-failure + ``` +- (Optional) Install to `/usr/local` + ```sh + make install + ``` If you want [sanitizers](https://github.com/google/sanitizers) to be enabled, then add either the `-DSANITIZE_THREAD=ON -DSANITIZE_UNDEFINED=ON` or `-DSANITIZE_ADDRESS=ON` flags to cmake, running the tests will now also check with the sanitizers. ### Integration tests Integration tests require additional tools installed: + - [msgpack-cli](https://github.com/jakm/msgpack-cli) - [wiremock](https://github.com/tomakehurst/wiremock) - `jq` Installation details can be extracted from the [Dockerfile](https://github.com/DataDog/docker-library/blob/master/dd-opentracing-cpp/test/0.3.1/Dockerfile#L7-L14) for the container that is usually used when running integration tests. -The script below will run the integration tests directly. -``` +Run this command to run the integration tests directly. + +```sh test/integration/run_integration_tests_local.sh ```