Skip to content

Commit 895c869

Browse files
Little fixes and improvements in general documentation
1 parent 32898b5 commit 895c869

2 files changed

Lines changed: 19 additions & 26 deletions

File tree

.gitignore

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
/bazel-*
2-
/.build/
3-
/build/
4-
/build-*/
5-
/.coverage/
1+
.build/
2+
.cache/
3+
.coverage/
4+
.cursor/
5+
.DS_Store
6+
.install/
7+
.vscode
8+
bazel-*
9+
build-*/
610
build/
7-
811
dist/
9-
out/
1012
MODULE.bazel.lock
11-
.vscode
12-
.cache/
13-
.cursor/
14-
.DS_Store
13+
out/

README.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ The library has been tested and is compatible on the following CPU architecture,
5353
### Requirements
5454
`dd-trace-cpp` requires a [supported](#platform-support) C++17 compiler.
5555

56-
A recent version of CMake is required (`3.24`), which might not be in your
56+
A recent version of CMake is required (`3.28`), which might not be in your
5757
system's package manager. [bin/install-cmake](bin/install-cmake) is an installer
58-
for a recent CMake.
58+
for a recent CMake, on Linux.
5959

6060
### Building
61-
Build this library from source using [CMake][1].
61+
Build this library from source using [CMake](https://cmake.org).
6262

6363
```shell
6464
git clone 'https://github.com/datadog/dd-trace-cpp'
@@ -67,7 +67,7 @@ cmake -B build .
6767
cmake --build build -j
6868
```
6969

70-
By default CMake will generate both static and shared libraries. To build either on of them use
70+
By default CMake will generate both static and shared libraries. To build only one of them use
7171
either `BUILD_SHARED_LIBS` or `BUILD_STATIC_LIBS`. Example:
7272

7373
```shell
@@ -76,14 +76,11 @@ cmake -B build -DBUILD_SHARED_LIBS=1 .
7676

7777
### Installation
7878
Installation places a shared library and public headers into the appropriate system directories
79-
(`/usr/local/[...]`), or to a specified installation prefix.
79+
(`/usr/local/[...]`), or to a specified installation prefix. Example:
8080

8181
```shell
82-
cmake --install
83-
84-
# Here is how to install dd-trace-cpp into `.install/` within the source
85-
# repository.
86-
# cmake --install build --prefix=.install
82+
# Install dd-trace-cpp into `.install/` within the source repository.
83+
cmake --install build --prefix=.install
8784
```
8885

8986
### Optional: Linking to the shared library
@@ -111,18 +108,15 @@ Pass `-DDD_TRACE_BUILD_TESTING=1` to `cmake` to include the unit tests in the bu
111108

112109
The resulting unit test executable is `test/tests` within the build directory.
113110
```shell
114-
cmake -Bbuild -DDD_TRACE_BUILD_TESTING=1 ..
111+
cmake -Bbuild -DDD_TRACE_BUILD_TESTING=1 .
115112
cmake --build build -j
116113
./build/test/tests
117114
```
118115

119116
Alternatively, [bin/test](bin/test) is provided for convenience.
120117

121-
Code coverage reports are available [here][2].
118+
Code coverage reports are available on [CodeCov](https://app.codecov.io/gh/DataDog/dd-trace-cpp).
122119

123120
Contributing
124121
------------
125122
See the [contributing guidelines](CONTRIBUTING.md) and the [maintainer docs](doc/maintainers.md) for information on the overall structure of the repository.
126-
127-
[1]: https://cmake.org/
128-
[2]: https://datadog.github.io/dd-trace-cpp-coverage

0 commit comments

Comments
 (0)