rticommunity / rticommunity/rticonnextdds-examples
Improve the "README.md" file of the examples using CMake to adapt to multiconfiguration generators
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 148
- Forks
- 153
- PR merge metrics
- No merged PRs in 30d
Description
What is the current behavior?
The documentation related to the examples include the following line:
cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_SHARED_LIBS=ON .. -G "Visual Studio 15 2017" -A x64
With the latest FindPackage CMake script, we support multiconfiguration projects. So, it is not a really good example to use the Visual Studio 15 2017 generator with the CMAKE_BUILD_TYPE CMake variable.
Suggested solutions
Use another generator for the same example or extend the example to show multiconfiguration and non-multiconfiguration generators.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the README.md documentation for the examples and locate the CMake command using the Visual Studio 15 2017 generator with CMAKE_BUILD_TYPE. Update the example to demonstrate appropriate multiconfiguration and non-multiconfiguration usage, then verify that the documented commands match the supported CMake generators.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100