Skip to content
This repository was archived by the owner on Aug 30, 2022. It is now read-only.

Commit f88e8fe

Browse files
isaacbrodskyisaachier
authored andcommitted
Add build instructions to README (#111)
Instructions for building and running the example are added to README. Fixed formatting issue in CONTRIBUTING.md. Signed-off-by: Isaac Brodsky <[email protected]>
1 parent 29e04be commit f88e8fe

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ by the Linux Kernel community and is a simple statement that you, as a
3838
contributor, have the legal right to make the contribution. See the [DCO](DCO)
3939
file for details.
4040

41+
```
4142
/*
4243
* Copyright (c) 2018, The Jaeger Authors
4344
*

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,46 @@
11
[![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![OpenTracing 1.0 Enabled][ot-img]][ot-url]
22

33
# jaeger-client-cpp
4-
C++ OpenTracing binding for Jaeger
4+
C++ OpenTracing binding for [Jaeger](https://www.jaegertracing.io/)
55

66
## Contributing
77

88
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
99

10-
## Generated files
10+
## Building
11+
12+
jaeger-client-cpp is built using CMake. It will automatically download
13+
needed dependencies using [Hunter](https://docs.hunter.sh/en/latest/).
14+
15+
To build:
16+
17+
```bash
18+
mkdir build
19+
cd build
20+
cmake ..
21+
make
22+
```
23+
24+
After building, the [example](./examples/App.cpp) program can be run
25+
with:
26+
27+
```bash
28+
./app ../examples/config.yml
29+
```
30+
31+
To run tests:
32+
33+
```bash
34+
make test
35+
```
36+
37+
To install the library:
38+
39+
```bash
40+
make install
41+
```
42+
43+
### Generated files
1144

1245
This project uses Apache Thrift for wire-format protocol support code
1346
generation. It currently requires Thrift 0.11.0.

0 commit comments

Comments
 (0)