Skip to content

Commit

Permalink
Cosmetic update to doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
arobenko committed Apr 18, 2023
1 parent c1f4e48 commit 3cfdc90
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 13 deletions.
22 changes: 10 additions & 12 deletions doc/BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ of available options and other input parameters.

## Choosing C++ Standard

Since CMake v3.1 it became possible to set version of C++ standard by setting
Since CMake **v3.1** it became possible to set version of C++ standard by setting
**CMAKE_CXX_STANDARD** variable. If no value of this variable is set in command
line arguments, default value **11** will be assigned to it. In order to use
c++14 standard in compilation, set the variable value to **14**.
Expand All @@ -29,26 +29,24 @@ generate Makefile-s on Windows by providing additional **-G "NMake Makefiles"**
to **cmake**. In this case use **nmake** utility instead of **make**.

Please review the examples below and use appropriate option that suites your
needs. Remember to add **-DCMAKE_BUILD_TYPE=Release** option for release
builds.
needs.

### Install Headers of the **COMMS** Library Linux Example

### Complete Build Linux Example
```
$> cd /path/to/comms
$> mkdir build && cd build
$> cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/some/install/dir
$> cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/some/install/dir
$> make install
```

### Install Only Headers-only **COMMS** Library Linux Example
This example will skip build of any tool available, it will just install
the **COMMS** library headers in **install/include** subdirectory.
### Build Unittests in Debug Mode Linux Example

```
$> cd /path/to/comms
$> mkdir build && cd build
$> cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/some/install/dir \
-DCC_COMMS_BUILD_UNIT_TESTS=OFF
$> cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/some/install/dir \
-DCC_COMMS_BUILD_UNIT_TESTS=ON
$> make install
```
### Windows + Visual Studio Build Example
Expand All @@ -57,8 +55,8 @@ Generate Makefile-s with **cmake** and use Visual Studio compiler to build.
```
$> cd /path/to/comms
$> mkdir build && cd build
$> cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/some/install/dir \
-G "NMake Makefiles" ..
$> cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/some/install/dir \
-G "NMake Makefiles"
$> nmake install
```

Expand Down
2 changes: 1 addition & 1 deletion doc/CMake.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If the package was successfully found, the target `cc::comms` needs
to be defined. Linking to `cc::comms` target will add all the relevant
include paths.

Since **v5.1" the comms library can also be found using the following calls:
Since **v5.1** the comms library can also be found using the following calls:
```
find_package(comms NO_MODULE)
find_package(cc_comms NO_MODULE)
Expand Down

0 comments on commit 3cfdc90

Please sign in to comment.