Skip to content

Commit b157216

Browse files
authored
Cleanup INSTALL.md (#1757)
1 parent 702a68c commit b157216

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

INSTALL.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can link OpenTelemetry C++ SDK with libraries provided in
1212

1313
## Build instructions using CMake
1414

15-
### Prerequisites for CMake
15+
### Prerequisites for CMake build
1616

1717
- A supported platform (e.g. Windows, macOS or Linux). Refer to [Platforms
1818
Supported](./README.md#supported-development-platforms) for more information.
@@ -38,9 +38,9 @@ You can link OpenTelemetry C++ SDK with libraries provided in
3838
[GoogleBenchmark Build
3939
Instructions](https://github.com/google/benchmark#installation).
4040
- Apart from above core requirements, the Exporters and Propagators have their
41-
build dependencies which are not covered here. E.g, Otlp Exporter needs
42-
grpc/protobuf library, Zipkin exporter needs nlohmann-json and libcurl, ETW
43-
exporter need nlohmann-json to build. This is covered in the build
41+
build dependencies which are not covered here. E.g, the OTLP Exporter needs
42+
grpc/protobuf library, the Zipkin exporter needs nlohmann-json and libcurl,
43+
the ETW exporter needs nlohmann-json to build. This is covered in the build
4444
instructions for each of these components.
4545

4646
### Building as standalone CMake Project
@@ -50,8 +50,7 @@ You can link OpenTelemetry C++ SDK with libraries provided in
5050
```console
5151
# Change to the directory where you want to create the code repository
5252
$ cd ~
53-
$ mkdir source && cd source
54-
$ git clone --recursive https://github.com/open-telemetry/opentelemetry-cpp
53+
$ mkdir source && cd source && git clone --recursive https://github.com/open-telemetry/opentelemetry-cpp
5554
Cloning into 'opentelemetry-cpp'...
5655
...
5756
Resolving deltas: 100% (3225/3225), done.
@@ -63,8 +62,7 @@ You can link OpenTelemetry C++ SDK with libraries provided in
6362

6463
```console
6564
$ cd opentelemetry-cpp
66-
$ mkdir build && cd build
67-
$ cmake ..
65+
$ mkdir build && cd build && cmake ..
6866
-- The C compiler identification is GNU 9.3.0
6967
-- The CXX compiler identification is GNU 9.3.0
7068
...
@@ -83,12 +81,12 @@ You can link OpenTelemetry C++ SDK with libraries provided in
8381
inclusion in shared libraries, this variable is used.
8482
- `-DBUILD_SHARED_LIBS=ON` : To build shared libraries for the targets.
8583
Please refer to note [below](#building-shared-libs-for-windows) for
86-
Windows DLL support
87-
- `-DWITH_OTLP=ON` : To enable building Otlp exporter.
84+
Windows DLL support.
85+
- `-DWITH_OTLP=ON` : To enable building OTLP exporter.
8886
- `-DWITH_PROMETHEUS=ON` : To enable building prometheus exporter.
8987

90-
3. Once build configuration is created, build the CMake targets - this includes
91-
building SDKs, and building unittests for API and SDK. Note that since API is
88+
3. Once the build configuration is created, build the CMake targets - this
89+
includes building SDKs and unittests for API and SDK. Note that since API is
9290
header only library, no separate build is triggered for it.
9391

9492
```console
@@ -121,7 +119,7 @@ You can link OpenTelemetry C++ SDK with libraries provided in
121119
files for SDK at custom/default install location.
122120

123121
```console
124-
$ cmake --install . --prefix /<install_root>/
122+
$ cmake --install . --prefix /<install-root>/
125123
-- Installing: /<install-root>/lib/cmake/opentelemetry-cpp/opentelemetry-cpp-config.cmake
126124
-- Installing: /<install-root>/lib/cmake/opentelemetry-cpp/opentelemetry-cpp-config-version.cmake
127125
...
@@ -155,7 +153,7 @@ NOTE: Experimental, and not supported for all the components. Make sure the
155153
there is a different version of googletest already installed in system-defined
156154
path.
157155

158-
### Prerequisites for Bazel
156+
### Prerequisites for Bazel build
159157

160158
- A supported platform (e.g. Windows, macOS or Linux). Refer to [Platforms
161159
Supported](./README.md#supported-development-platforms) for more information.

0 commit comments

Comments
 (0)