Default behaviour for yaml-cpp install targets missing in README
Nobody has claimed this yet.
- #1439 by @wyf027 — closed without merging
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- cmake, cpp
- Domain
- documentation
Research direction
Read the README section “How to integrate it within your project using CMake” and compare its instructions with the install option changed in PR #1007. Add a note explaining when to set option(YAML_CPP_INSTALL ON); done means the README makes this requirement clear for projects that fetch yaml-cpp as a subproject.
Written by the indexing model from the issue text.
Description
I struggled a lot to find out why the targets for yaml-cpp did not get installed, when fetching them like described in the README in the CMakeLists.txt of my own project.
Now I found out, that in this PR (https://github.com/jbeder/yaml-cpp/pull/1007) it was changed to not be always ON by default to install the targets.
It would probably be really helpful to add a small comment to the README under the section 'How to integrate it within your project using CMake' that it could be necessary to add option(YAML_CPP_INSTALL ON) if yaml-cpp is not the top project, because it could save time for other developers as this feels like a pretty standard use case.
If you agree it would be nice to add this.
- Dominant language
- C++
- Stars
- 6.1k
- Forks
- 2.2k
- Avg merge
- 22h 2m
- Merged PRs (30d)
- 1
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from jbeder/yaml-cpp
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
-
Difficulty 3/5 Half a day Newbie friendliness 55/100
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
Similar issues
-
artifact:simulation-scenario domain:physics good first issue help wanted role:validation testing
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 3 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
moneymanagerex/moneymanagerex#8600 · 1 comment ·
Maintainers usually reply within 4 days
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
NVIDIA/accelerated-computing-hub#294 ·
Maintainers usually reply within 4 days