Skip to content

Commit 2fb43cf

Browse files
committed
Add documentation around cmake
1 parent c02caa8 commit 2fb43cf

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/cpp/quickstart.md

+7
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ The `cmake` command can also overwrite the following variables by passing them t
143143
- `CMAKE_BUILD_TYPE`: String variable to determine build type. The default value for this variable is "Release".
144144
- `BUILD_SHARED_LIBS`: Boolean ON/OFF variable to turn on the build of shared libraries. The default value for this variable is ON. **Shared libraries currently are only supported on Linux.** This limitation is temporary and will be addressed in future releases.
145145
- `BUILD_CHOREOGRAPHY_LIBS`: Boolean ON/OFF variable to turn on the build of choreography libraries. The default value for this variable is ON.
146+
- `CMAKE_POSITION_INDEPENDENT_CODE`: Boolean true/false variable to enable compilation of position independent machine code. This is necessary when linking the library against other shared libraries
146147

147148
**On Linux:**
148149

@@ -152,6 +153,12 @@ Build the SDK using the `make` command below.
152153
make -j6 install
153154
```
154155

156+
Build the SDK and generate a debian package containing command using the `make` command below:
157+
158+
```
159+
make -j6 install package
160+
```
161+
155162
The `make` command generates a lot of deprecation warnings during the compiling of the classes generated from the protobuf definitions. This is expected as the protobuf definitions contain `deprecated` flags for fields that will not be supported in future versions of the SDK.
156163

157164
**On Windows:**

0 commit comments

Comments
 (0)