diff --git a/README.md b/README.md index 70f09e0..570fb39 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 @@ -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 +$ ./rpc_client +``` \ No newline at end of file