Skip to content

Update README #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PLeVasseur merged 2 commits into from
May 9, 2025
Merged

Update README #32

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ddc926
updated the readme after change to zenoh-transport
MaximilianToe May 9, 2025
c0df397
updated dependency versions
MaximilianToe May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# up-zenoh-example-cpp
C++ Example application and service that utilizes up-client-zenoh-cpp
C++ Example application and service that utilizes up-transport-zenoh-cpp

## Getting Started
### Requirements:
Expand All @@ -11,9 +11,9 @@ C++ Example application and service that utilizes up-client-zenoh-cpp

Use the up-conan-recipes repo and compile the following recipes:
```
$ conan create --version 1.6.0 --build=missing up-core-api/developer
$ conan create --version 1.0.1-rc1 --build=missing up-cpp/developer
$ conan create --version 1.0.0-dev --build=missing up-transport-socket-cpp/developer
$ conan create --version 1.6.0-alpha4 --build=missing up-core-api/release
$ conan create --version 1.0.1-dev --build=missing up-cpp/developer
$ conan create --version 1.0.0-dev --build=missing up-transport-zenoh-cpp/developer
```

## How to Build
Expand All @@ -33,3 +33,12 @@ $ cmake --preset conan-debug
$ cd build/Debug
$ cmake --build . -- -j
```

## Usage
After completing the project build, the build artifacts can generally be found in the `build/Release/bin` directory within your workspace.
You can run the example using the supplied configuration file located in the `/resources` directory.For instance, to run the RPC example, use the following commands:

```bash
$ ./rpc_server <path/to/config>
$ ./rpc_client <path/to/config>
```