Skip to content

Commit 0e2b659

Browse files
patrickelectricWilliangalvani
authored andcommitted
README: Improve information about deployment branch and cmake based projects
Signed-off-by: Patrick José Pereira <[email protected]>
1 parent 46ee009 commit 0e2b659

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,25 @@ This repository has the ping_message base class, and templates + scripts to auto
99

1010
## Usage
1111

12+
#### Generated files
13+
1214
If you would like to use the C++ API in your project, checkout the [deployment branch](https://github.com/bluerobotics/ping-cpp/tree/deployment).
15+
16+
#### CMake project
17+
18+
The **master branch** can be used directly in CMake based projects for desktop or SBC applications.
19+
##### Example
20+
21+
```sh
22+
# Clone the repository
23+
git clone https://github.com/bluerobotics/ping-cpp
24+
cd ping-cpp
25+
# Update the submodules
26+
git submodule update --init --recursive
27+
# Configure and build the project in debug mode
28+
cmake -B build -DCMAKE_BUILD_TYPE=Debug && cmake --build build --parallel --config Debug
29+
# Connect a Ping device and use the correct USB as argument
30+
./build/test-device --conn serial:/dev/ttyUSB0:115200
31+
# If you have a Ping1D connected, you can run the test program for the device
32+
./build/test-device-ping1d --conn serial:/dev/ttyUSB0:115200
33+
```

0 commit comments

Comments
 (0)