Skip to content

Commit e1795c0

Browse files
committed
Minor fixes to angle brackets in README.md
1 parent 2bddeb8 commit e1795c0

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
MATLAB® interface to [OpenTelemetry™](https://opentelemetry.io/), based on the [OpenTelemetry Specification](https://opentelemetry.io/docs/reference/specification/). OpenTelemetry is an observability framework for creating and managing telemetry data, such as traces, metrics, and logs. This data can then be sent to an observability back-end for monitoring, alerts, and analysis.
44

5-
## Status
5+
### Status
66
- Currently only tracing is supported. Metrics and logs will be in the future.
77
- This package is supported and has been tested on Windows® and Linux®. We will add macOS support in the future.
88

@@ -37,17 +37,17 @@ Before proceeding, ensure that the below products are installed:
3737

3838
2. Download, build and install [OpenTelemetry C++](https://github.com/open-telemetry/opentelemetry-cpp)
3939
```
40-
cd \<opentelemetry-cpp-root>\
41-
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_CXX_STANDARD=20 -DWITH_OTLP_HTTP=TRUE -DWITH_OTLP_GRPC=TRUE -DOPENTELEMETRY_INSTALL=ON -DCMAKE_TOOLCHAIN_FILE=\<vcpkg_root>\scripts\buildsystems\vcpkg.cmake
40+
cd <opentelemetry-cpp-root>
41+
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_CXX_STANDARD=20 -DWITH_OTLP_HTTP=TRUE -DWITH_OTLP_GRPC=TRUE -DOPENTELEMETRY_INSTALL=ON -DCMAKE_TOOLCHAIN_FILE=<vcpkg_root>\scripts\buildsystems\vcpkg.cmake
4242
cmake --build build --config Release --target ALL_BUILD
43-
cmake --install build --prefix \<opentelemetry-cpp-installdir>\
43+
cmake --install build --prefix <opentelemetry-cpp-installdir>
4444
```
4545
3. Download OpenTelemetry MATLAB
4646

4747
4. Build and install OpenTelemetry MATLAB
4848
```
49-
cd \<opentelemetry-matlab-root>\
50-
cmake -S . -B build -DCMAKE_INSTALL_PREFIX=\<opentelemetry-matlab-installdir>\ -DCMAKE_TOOLCHAIN_FILE=\<vcpkg_root>\scripts\buildsystems\vcpkg.cmake -DCMAKE_PREFIX_PATH=\<path to opentelemetry-cpp-config.cmake>\
49+
cd <opentelemetry-matlab-root>
50+
cmake -S . -B build -DCMAKE_INSTALL_PREFIX=<opentelemetry-matlab-installdir> -DCMAKE_TOOLCHAIN_FILE=<vcpkg_root>\scripts\buildsystems\vcpkg.cmake -DCMAKE_PREFIX_PATH=<path to opentelemetry-cpp-config.cmake>
5151
cmake --build build --config Release --target install
5252
5353
```
@@ -56,12 +56,12 @@ cmake --build build --config Release --target install
5656
## Getting Started
5757
1. Start OpenTelemetry Collector
5858
```
59-
otelcol --config \<otelcol-config-yaml>\
59+
otelcol --config <otelcol-config-yaml>
6060
```
6161
2. Start MATLAB
6262
3. Add the OpenTelemetry MATLAB install directories to your MATLAB path
6363
```
64-
>> addpath \<OpenTelemetry MATLAB installdir>\
64+
>> addpath <OpenTelemetry MATLAB installdir>
6565
```
6666
## Examples
6767
1. Create a default tracer provider and save it.
@@ -81,7 +81,7 @@ otelcol --config \<otelcol-config-yaml>\
8181
4. If your collector is configured to display the data, you should see your span displayed.
8282

8383
## Help
84-
To view documentation of individual function, type "help <function_name>". For example,
84+
To view documentation of individual function, type "help \<function_name>\". For example,
8585
```
8686
>> help opentelemetry.sdk.trace.TracerProvider
8787
```

0 commit comments

Comments
 (0)