niklas/cyclonedds
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme file with info on adding Bintray repository to conan remotes list

Browse source 
Signed-off-by: Dennis Potman <dennis.potman@adlinktech.com>
This commit is contained in:
Dennis Potman 2020-02-06 12:00:43 +01:00 • committed by Jeroen Koekkoek
parent 150f20d10c
commit e4069d79ca
1 changed files with 19 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -36,7 +36,7 @@ current [ROS2 RMW layer](https://github.com/ros2/rmw_cyclonedds), that is suffic
To obtain Eclipse Cyclone DDS, do To obtain Eclipse Cyclone DDS, do
$ git clone https://github.com/eclipse-cyclonedds/cyclonedds.git $ git clone https://github.com/eclipse-cyclonedds/cyclonedds.git
$ cd cyclonedds $ cd cyclonedds
$ mkdir build $ mkdir build
@ -66,7 +66,7 @@ generating build files. For example, "Visual Studio 15 2017 Win64" would target
using Visual Studio 2017. using Visual Studio 2017.
To install it after a successful build, do: To install it after a successful build, do:
$ cmake --build . --target install $ cmake --build . --target install
which will copy everything to: which will copy everything to:
@ -102,12 +102,21 @@ Such a build requires the presence of [CUnit](http://cunit.sourceforge.net/). Y
yourself, or you can choose to instead rely on the [Conan](https://conan.io) packaging system that yourself, or you can choose to instead rely on the [Conan](https://conan.io) packaging system that
the CI build infrastructure also uses. In that case, install Conan and do: the CI build infrastructure also uses. In that case, install Conan and do:
$ conan install .. $ conan install .. --build missing
in the build directory prior to running cmake. For Windows, depending on the generator, you might in the build directory prior to running cmake.
also need to add switches to select the architecture and build type, e.g., ``conan install -s
arch=x86_64 -s build_type=Debug ..`` This will automatically download and/or build CUnit (and, at The CUnit Conan package is hosted in the [Bintray repository](https://bintray.com/bincrafters/public-conan).
the moment, OpenSSL). In case this repository was not added to your Conan remotes list yet (and the above mentioned install
command failed because it could not find the CUnit package), you can add the Bintray repository by:
$ conan remote add <REMOTE> https://api.bintray.com/conan/bincrafters/public-conan
Replace ``<REMOTE>`` with a name that identifies the repository (e.g. my-conan-bintray).
For Windows, depending on the generator, you might also need to add switches to select the architecture
and build type, e.g., ``conan install -s arch=x86_64 -s build_type=Debug ..`` This will automatically
download and/or build CUnit (and, at the moment, OpenSSL).
## Documentation ## Documentation
@ -128,14 +137,14 @@ to run the program, it is merely to illustrate the process.
$ cd roundtrip $ cd roundtrip
$ cmake <install-location>/share/CycloneDDS/examples/roundtrip $ cmake <install-location>/share/CycloneDDS/examples/roundtrip
$ cmake --build . $ cmake --build .
On one terminal start the application that will be responding to pings: On one terminal start the application that will be responding to pings:
$ ./RoundtripPong $ ./RoundtripPong
On another terminal, start the application that will be sending the pings: On another terminal, start the application that will be sending the pings:
$ ./RoundtripPing 0 0 0 $ ./RoundtripPing 0 0 0
# payloadSize: 0 | numSamples: 0 | timeOut: 0 # payloadSize: 0 | numSamples: 0 | timeOut: 0
# Waiting for startup jitter to stabilise # Waiting for startup jitter to stabilise
# Warm up complete. # Warm up complete.